Class: Aws::NetworkFirewall::Client

Inherits:
Seahorse::Client::Base show all
Includes:
ClientStubs
Defined in:
gems/aws-sdk-networkfirewall/lib/aws-sdk-networkfirewall/client.rb

Overview

An API client for NetworkFirewall. To construct a client, you need to configure a :region and :credentials.

client = Aws::NetworkFirewall::Client.new(
  region: region_name,
  credentials: credentials,
  # ...
)

For details on configuring region and credentials see the developer guide.

See #initialize for a full list of supported configuration options.

Instance Attribute Summary

Attributes inherited from Seahorse::Client::Base

#config, #handlers

API Operations collapse

Instance Method Summary collapse

Methods included from ClientStubs

#api_requests, #stub_data, #stub_responses

Methods inherited from Seahorse::Client::Base

add_plugin, api, clear_plugins, define, new, #operation_names, plugins, remove_plugin, set_api, set_plugins

Methods included from Seahorse::Client::HandlerBuilder

#handle, #handle_request, #handle_response

Constructor Details

#initialize(options) ⇒ Client

Returns a new instance of Client.

Parameters:

  • options (Hash)

Options Hash (options):

  • :plugins (Array<Seahorse::Client::Plugin>) — default: []] —

    A list of plugins to apply to the client. Each plugin is either a class name or an instance of a plugin class.

  • :credentials (required, Aws::CredentialProvider) —

    Your AWS credentials. This can be an instance of any one of the following classes:

    • Aws::Credentials - Used for configuring static, non-refreshing credentials.

    • Aws::SharedCredentials - Used for loading static credentials from a shared file, such as ~/.aws/config.

    • Aws::AssumeRoleCredentials - Used when you need to assume a role.

    • Aws::AssumeRoleWebIdentityCredentials - Used when you need to assume a role after providing credentials via the web.

    • Aws::SSOCredentials - Used for loading credentials from AWS SSO using an access token generated from aws login.

    • Aws::ProcessCredentials - Used for loading credentials from a process that outputs to stdout.

    • Aws::InstanceProfileCredentials - Used for loading credentials from an EC2 IMDS on an EC2 instance.

    • Aws::ECSCredentials - Used for loading credentials from instances running in ECS.

    • Aws::CognitoIdentityCredentials - Used for loading credentials from the Cognito Identity service.

    When :credentials are not configured directly, the following locations will be searched for credentials:

    • Aws.config[:credentials]
    • The :access_key_id, :secret_access_key, :session_token, and :account_id options.
    • ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY'], ENV['AWS_SESSION_TOKEN'], and ENV['AWS_ACCOUNT_ID']
    • ~/.aws/credentials
    • ~/.aws/config
    • EC2/ECS IMDS instance profile - When used by default, the timeouts are very aggressive. Construct and pass an instance of Aws::InstanceProfileCredentials or Aws::ECSCredentials to enable retries and extended timeouts. Instance profile credential fetching can be disabled by setting ENV['AWS_EC2_METADATA_DISABLED'] to true.
  • :region (required, String) —

    The AWS region to connect to. The configured :region is used to determine the service :endpoint. When not passed, a default :region is searched for in the following locations:

    • Aws.config[:region]
    • ENV['AWS_REGION']
    • ENV['AMAZON_REGION']
    • ENV['AWS_DEFAULT_REGION']
    • ~/.aws/credentials
    • ~/.aws/config
  • :access_key_id (String)
  • :account_id (String)
  • :active_endpoint_cache (Boolean) — default: false —

    When set to true, a thread polling for endpoints will be running in the background every 60 secs (default). Defaults to false.

  • :adaptive_retry_wait_to_fill (Boolean) — default: true —

    Used only in adaptive retry mode. When true, the request will sleep until there is sufficent client side capacity to retry the request. When false, the request will raise a RetryCapacityNotAvailableError and will not retry instead of sleeping.

  • :client_side_monitoring (Boolean) — default: false —

    When true, client-side metrics will be collected for all API requests from this client.

  • :client_side_monitoring_client_id (String) — default: "" —

    Allows you to provide an identifier for this client which will be attached to all generated client side metrics. Defaults to an empty string.

  • :client_side_monitoring_host (String) — default: "127.0.0.1" —

    Allows you to specify the DNS hostname or IPv4 or IPv6 address that the client side monitoring agent is running on, where client metrics will be published via UDP.

  • :client_side_monitoring_port (Integer) — default: 31000 —

    Required for publishing client metrics. The port that the client side monitoring agent is running on, where client metrics will be published via UDP.

  • :client_side_monitoring_publisher (Aws::ClientSideMonitoring::Publisher) — default: Aws::ClientSideMonitoring::Publisher —

    Allows you to provide a custom client-side monitoring publisher class. By default, will use the Client Side Monitoring Agent Publisher.

  • :convert_params (Boolean) — default: true —

    When true, an attempt is made to coerce request parameters into the required types.

  • :correct_clock_skew (Boolean) — default: true —

    Used only in standard and adaptive retry modes. Specifies whether to apply a clock skew correction and retry requests with skewed client clocks.

  • :defaults_mode (String) — default: "legacy" —

    See DefaultsModeConfiguration for a list of the accepted modes and the configuration defaults that are included.

  • :disable_host_prefix_injection (Boolean) — default: false —

    Set to true to disable SDK automatically adding host prefix to default service endpoint when available.

  • :disable_request_compression (Boolean) — default: false —

    When set to 'true' the request body will not be compressed for supported operations.

  • :endpoint (String, URI::HTTPS, URI::HTTP) —

    Normally you should not configure the :endpoint option directly. This is normally constructed from the :region option. Configuring :endpoint is normally reserved for connecting to test or custom endpoints. The endpoint should be a URI formatted like:

    'http://example.com'
'https://example.com'
'http://example.com:123'
  • :endpoint_cache_max_entries (Integer) — default: 1000 —

    Used for the maximum size limit of the LRU cache storing endpoints data for endpoint discovery enabled operations. Defaults to 1000.

  • :endpoint_cache_max_threads (Integer) — default: 10 —

    Used for the maximum threads in use for polling endpoints to be cached, defaults to 10.

  • :endpoint_cache_poll_interval (Integer) — default: 60 —

    When :endpoint_discovery and :active_endpoint_cache is enabled, Use this option to config the time interval in seconds for making requests fetching endpoints information. Defaults to 60 sec.

  • :endpoint_discovery (Boolean) — default: false —

    When set to true, endpoint discovery will be enabled for operations when available.

  • :ignore_configured_endpoint_urls (Boolean) —

    Setting to true disables use of endpoint URLs provided via environment variables and the shared configuration file.

  • :log_formatter (Aws::Log::Formatter) — default: Aws::Log::Formatter.default —

    The log formatter.

  • :log_level (Symbol) — default: :info —

    The log level to send messages to the :logger at.

  • :logger (Logger) —

    The Logger instance to send log messages to. If this option is not set, logging will be disabled.

  • :max_attempts (Integer) — default: 3 —

    An integer representing the maximum number attempts that will be made for a single request, including the initial attempt. For example, setting this value to 5 will result in a request being retried up to 4 times. Used in standard and adaptive retry modes.

  • :profile (String) — default: "default" —

    Used when loading credentials from the shared credentials file at HOME/.aws/credentials. When not specified, 'default' is used.

  • :request_checksum_calculation (String) — default: "when_supported" —

    Determines when a checksum will be calculated for request payloads. Values are:

    • when_supported - (default) When set, a checksum will be calculated for all request payloads of operations modeled with the httpChecksum trait where requestChecksumRequired is true and/or a requestAlgorithmMember is modeled.
    • when_required - When set, a checksum will only be calculated for request payloads of operations modeled with the httpChecksum trait where requestChecksumRequired is true or where a requestAlgorithmMember is modeled and supplied.
  • :request_min_compression_size_bytes (Integer) — default: 10240 —

    The minimum size in bytes that triggers compression for request bodies. The value must be non-negative integer value between 0 and 10485780 bytes inclusive.

  • :response_checksum_validation (String) — default: "when_supported" —

    Determines when checksum validation will be performed on response payloads. Values are:

    • when_supported - (default) When set, checksum validation is performed on all response payloads of operations modeled with the httpChecksum trait where responseAlgorithms is modeled, except when no modeled checksum algorithms are supported.
    • when_required - When set, checksum validation is not performed on response payloads of operations unless the checksum algorithm is supported and the requestValidationModeMember member is set to ENABLED.
  • :retry_backoff (Proc) —

    A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay. This option is only used in the legacy retry mode.

  • :retry_base_delay (Float) — default: 0.3 —

    The base delay in seconds used by the default backoff function. This option is only used in the legacy retry mode.

  • :retry_jitter (Symbol) — default: :none —

    A delay randomiser function used by the default backoff function. Some predefined functions can be referenced by name - :none, :equal, :full, otherwise a Proc that takes and returns a number. This option is only used in the legacy retry mode.

    @see https://www.awsarchitectureblog.com/2015/03/backoff.html

  • :retry_limit (Integer) — default: 3 —

    The maximum number of times to retry failed requests. Only ~ 500 level server errors and certain ~ 400 level client errors are retried. Generally, these are throttling errors, data checksum errors, networking errors, timeout errors, auth errors, endpoint discovery, and errors from expired credentials. This option is only used in the legacy retry mode.

  • :retry_max_delay (Integer) — default: 0 —

    The maximum number of seconds to delay between retries (0 for no limit) used by the default backoff function. This option is only used in the legacy retry mode.

  • :retry_mode (String) — default: "legacy" —

    Specifies which retry algorithm to use. Values are:

    • legacy - The pre-existing retry behavior. This is default value if no retry mode is provided.

    • standard - A standardized set of retry rules across the AWS SDKs. This includes support for retry quotas, which limit the number of unsuccessful retries a client can make.

    • adaptive - An experimental retry mode that includes all the functionality of standard mode along with automatic client side throttling. This is a provisional mode that may change behavior in the future.

  • :sdk_ua_app_id (String) —

    A unique and opaque application ID that is appended to the User-Agent header as app/sdk_ua_app_id. It should have a maximum length of 50. This variable is sourced from environment variable AWS_SDK_UA_APP_ID or the shared config profile attribute sdk_ua_app_id.

  • :secret_access_key (String)
  • :session_token (String)
  • :sigv4a_signing_region_set (Array) —

    A list of regions that should be signed with SigV4a signing. When not passed, a default :sigv4a_signing_region_set is searched for in the following locations:

    • Aws.config[:sigv4a_signing_region_set]
    • ENV['AWS_SIGV4A_SIGNING_REGION_SET']
    • ~/.aws/config
  • :simple_json (Boolean) — default: false —

    Disables request parameter conversion, validation, and formatting. Also disables response data type conversions. The request parameters hash must be formatted exactly as the API expects.This option is useful when you want to ensure the highest level of performance by avoiding overhead of walking request parameters and response data structures.

  • :stub_responses (Boolean) — default: false —

    Causes the client to return stubbed responses. By default fake responses are generated and returned. You can specify the response data to return or errors to raise by calling ClientStubs#stub_responses. See ClientStubs for more information.

    Please note When response stubbing is enabled, no HTTP requests are made, and retries are disabled.

  • :telemetry_provider (Aws::Telemetry::TelemetryProviderBase) — default: Aws::Telemetry::NoOpTelemetryProvider —

    Allows you to provide a telemetry provider, which is used to emit telemetry data. By default, uses NoOpTelemetryProvider which will not record or emit any telemetry data. The SDK supports the following telemetry providers:

    • OpenTelemetry (OTel) - To use the OTel provider, install and require the opentelemetry-sdk gem and then, pass in an instance of a Aws::Telemetry::OTelProvider for telemetry provider.
  • :token_provider (Aws::TokenProvider) —

    A Bearer Token Provider. This can be an instance of any one of the following classes:

    • Aws::StaticTokenProvider - Used for configuring static, non-refreshing tokens.

    • Aws::SSOTokenProvider - Used for loading tokens from AWS SSO using an access token generated from aws login.

    When :token_provider is not configured directly, the Aws::TokenProviderChain will be used to search for tokens configured for your profile in shared configuration files.

  • :use_dualstack_endpoint (Boolean) —

    When set to true, dualstack enabled endpoints (with .aws TLD) will be used if available.

  • :use_fips_endpoint (Boolean) —

    When set to true, fips compatible endpoints will be used if available. When a fips region is used, the region is normalized and this config is set to true.

  • :validate_params (Boolean) — default: true —

    When true, request parameters are validated before sending the request.

  • :endpoint_provider (Aws::NetworkFirewall::EndpointProvider) —

    The endpoint provider used to resolve endpoints. Any object that responds to #resolve_endpoint(parameters) where parameters is a Struct similar to Aws::NetworkFirewall::EndpointParameters.

  • :http_continue_timeout (Float) — default: 1 —

    The number of seconds to wait for a 100-continue response before sending the request body. This option has no effect unless the request has "Expect" header set to "100-continue". Defaults to nil which disables this behaviour. This value can safely be set per request on the session.

  • :http_idle_timeout (Float) — default: 5 —

    The number of seconds a connection is allowed to sit idle before it is considered stale. Stale connections are closed and removed from the pool before making a request.

  • :http_open_timeout (Float) — default: 15 —

    The default number of seconds to wait for response data. This value can safely be set per-request on the session.

  • :http_proxy (URI::HTTP, String) —

    A proxy to send requests through. Formatted like 'http://proxy.com:123'.

  • :http_read_timeout (Float) — default: 60 —

    The default number of seconds to wait for response data. This value can safely be set per-request on the session.

  • :http_wire_trace (Boolean) — default: false —

    When true, HTTP debug output will be sent to the :logger.

  • :on_chunk_received (Proc) —

    When a Proc object is provided, it will be used as callback when each chunk of the response body is received. It provides three arguments: the chunk, the number of bytes received, and the total number of bytes in the response (or nil if the server did not send a content-length).

  • :on_chunk_sent (Proc) —

    When a Proc object is provided, it will be used as callback when each chunk of the request body is sent. It provides three arguments: the chunk, the number of bytes read from the body, and the total number of bytes in the body.

  • :raise_response_errors (Boolean) — default: true —

    When true, response errors are raised.

  • :ssl_ca_bundle (String) —

    Full path to the SSL certificate authority bundle file that should be used when verifying peer certificates. If you do not pass :ssl_ca_bundle or :ssl_ca_directory the the system default will be used if available.

  • :ssl_ca_directory (String) —

    Full path of the directory that contains the unbundled SSL certificate authority files for verifying peer certificates. If you do not pass :ssl_ca_bundle or :ssl_ca_directory the the system default will be used if available.

  • :ssl_ca_store (String) —

    Sets the X509::Store to verify peer certificate.

  • :ssl_cert (OpenSSL::X509::Certificate) —

    Sets a client certificate when creating http connections.

  • :ssl_key (OpenSSL::PKey) —

    Sets a client key when creating http connections.

  • :ssl_timeout (Float) —

    Sets the SSL timeout in seconds

  • :ssl_verify_peer (Boolean) — default: true —

    When true, SSL peer certificates are verified when establishing a connection.



474
475
476
 
# File 'gems/aws-sdk-networkfirewall/lib/aws-sdk-networkfirewall/client.rb', line 474

def initialize(*args)
  super
end

Instance Method Details

#associate_firewall_policy(params = {}) ⇒ Types::AssociateFirewallPolicyResponse

Associates a FirewallPolicy to a Firewall.

A firewall policy defines how to monitor and manage your VPC network traffic, using a collection of inspection rule groups and other settings. Each firewall requires one firewall policy association, and you can use the same firewall policy for multiple firewalls.

Examples:

Request syntax with placeholder values


resp = client.associate_firewall_policy({
  update_token: "UpdateToken",
  firewall_arn: "ResourceArn",
  firewall_name: "ResourceName",
  firewall_policy_arn: "ResourceArn", # required
})

Response structure


resp.firewall_arn #=> String
resp.firewall_name #=> String
resp.firewall_policy_arn #=> String
resp.update_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :update_token (String) —

    An optional token that you can use for optimistic locking. Network Firewall returns a token to your requests that access the firewall. The token marks the state of the firewall resource at the time of the request.

    To make an unconditional change to the firewall, omit the token in your update request. Without the token, Network Firewall performs your updates regardless of whether the firewall has changed since you last retrieved it.

    To make a conditional change to the firewall, provide the token in your update request. Network Firewall uses the token to ensure that the firewall hasn't changed since you last retrieved it. If it has changed, the operation fails with an InvalidTokenException. If this happens, retrieve the firewall again to get a current copy of it with a new token. Reapply your changes as needed, then try the operation again using the new token.

  • :firewall_arn (String) —

    The Amazon Resource Name (ARN) of the firewall.

    You must specify the ARN or the name, and you can specify both.

  • :firewall_name (String) —

    The descriptive name of the firewall. You can't change the name of a firewall after you create it.

    You must specify the ARN or the name, and you can specify both.

  • :firewall_policy_arn (required, String) —

    The Amazon Resource Name (ARN) of the firewall policy.

Returns:

See Also:



547
548
549
550
 
# File 'gems/aws-sdk-networkfirewall/lib/aws-sdk-networkfirewall/client.rb', line 547

def associate_firewall_policy(params = {}, options = {})
  req = build_request(:associate_firewall_policy, params)
  req.send_request(options)
end

#associate_subnets(params = {}) ⇒ Types::AssociateSubnetsResponse

Associates the specified subnets in the Amazon VPC to the firewall. You can specify one subnet for each of the Availability Zones that the VPC spans.

This request creates an Network Firewall firewall endpoint in each of the subnets. To enable the firewall's protections, you must also modify the VPC's route tables for each subnet's Availability Zone, to redirect the traffic that's coming into and going out of the zone through the firewall endpoint.

Examples:

Request syntax with placeholder values


resp = client.associate_subnets({
  update_token: "UpdateToken",
  firewall_arn: "ResourceArn",
  firewall_name: "ResourceName",
  subnet_mappings: [ # required
    {
      subnet_id: "CollectionMember_String", # required
      ip_address_type: "DUALSTACK", # accepts DUALSTACK, IPV4, IPV6
    },
  ],
})

Response structure


resp.firewall_arn #=> String
resp.firewall_name #=> String
resp.subnet_mappings #=> Array
resp.subnet_mappings[0].subnet_id #=> String
resp.subnet_mappings[0].ip_address_type #=> String, one of "DUALSTACK", "IPV4", "IPV6"
resp.update_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :update_token (String) —

    An optional token that you can use for optimistic locking. Network Firewall returns a token to your requests that access the firewall. The token marks the state of the firewall resource at the time of the request.

    To make an unconditional change to the firewall, omit the token in your update request. Without the token, Network Firewall performs your updates regardless of whether the firewall has changed since you last retrieved it.

    To make a conditional change to the firewall, provide the token in your update request. Network Firewall uses the token to ensure that the firewall hasn't changed since you last retrieved it. If it has changed, the operation fails with an InvalidTokenException. If this happens, retrieve the firewall again to get a current copy of it with a new token. Reapply your changes as needed, then try the operation again using the new token.

  • :firewall_arn (String) —

    The Amazon Resource Name (ARN) of the firewall.

    You must specify the ARN or the name, and you can specify both.

  • :firewall_name (String) —

    The descriptive name of the firewall. You can't change the name of a firewall after you create it.

    You must specify the ARN or the name, and you can specify both.

  • :subnet_mappings (required, Array<Types::SubnetMapping>) —

    The IDs of the subnets that you want to associate with the firewall.

Returns:

See Also:



629
630
631
632
 
# File 'gems/aws-sdk-networkfirewall/lib/aws-sdk-networkfirewall/client.rb', line 629

def associate_subnets(params = {}, options = {})
  req = build_request(:associate_subnets, params)
  req.send_request(options)
end

#create_firewall(params = {}) ⇒ Types::CreateFirewallResponse

Creates an Network Firewall Firewall and accompanying FirewallStatus for a VPC.

The firewall defines the configuration settings for an Network Firewall firewall. The settings that you can define at creation include the firewall policy, the subnets in your VPC to use for the firewall endpoints, and any tags that are attached to the firewall Amazon Web Services resource.

After you create a firewall, you can provide additional settings, like the logging configuration.

To update the settings for a firewall, you use the operations that apply to the settings themselves, for example UpdateLoggingConfiguration, AssociateSubnets, and UpdateFirewallDeleteProtection.

To manage a firewall's tags, use the standard Amazon Web Services resource tagging operations, ListTagsForResource, TagResource, and UntagResource.

To retrieve information about firewalls, use ListFirewalls and DescribeFirewall.

To generate a report on the last 30 days of traffic monitored by a firewall, use StartAnalysisReport.

Examples:

Request syntax with placeholder values


resp = client.create_firewall({
  firewall_name: "ResourceName", # required
  firewall_policy_arn: "ResourceArn", # required
  vpc_id: "VpcId",
  subnet_mappings: [
    {
      subnet_id: "CollectionMember_String", # required
      ip_address_type: "DUALSTACK", # accepts DUALSTACK, IPV4, IPV6
    },
  ],
  delete_protection: false,
  subnet_change_protection: false,
  firewall_policy_change_protection: false,
  description: "Description",
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
  encryption_configuration: {
    key_id: "KeyId",
    type: "CUSTOMER_KMS", # required, accepts CUSTOMER_KMS, AWS_OWNED_KMS_KEY
  },
  enabled_analysis_types: ["TLS_SNI"], # accepts TLS_SNI, HTTP_HOST
})

Response structure


resp.firewall.firewall_name #=> String
resp.firewall.firewall_arn #=> String
resp.firewall.firewall_policy_arn #=> String
resp.firewall.vpc_id #=> String
resp.firewall.subnet_mappings #=> Array
resp.firewall.subnet_mappings[0].subnet_id #=> String
resp.firewall.subnet_mappings[0].ip_address_type #=> String, one of "DUALSTACK", "IPV4", "IPV6"
resp.firewall.delete_protection #=> Boolean
resp.firewall.subnet_change_protection #=> Boolean
resp.firewall.firewall_policy_change_protection #=> Boolean
resp.firewall.description #=> String
resp.firewall.firewall_id #=> String
resp.firewall.tags #=> Array
resp.firewall.tags[0].key #=> String
resp.firewall.tags[0].value #=> String
resp.firewall.encryption_configuration.key_id #=> String
resp.firewall.encryption_configuration.type #=> String, one of "CUSTOMER_KMS", "AWS_OWNED_KMS_KEY"
resp.firewall.enabled_analysis_types #=> Array
resp.firewall.enabled_analysis_types[0] #=> String, one of "TLS_SNI", "HTTP_HOST"
resp.firewall_status.status #=> String, one of "PROVISIONING", "DELETING", "READY"
resp.firewall_status.configuration_sync_state_summary #=> String, one of "PENDING", "IN_SYNC", "CAPACITY_CONSTRAINED"
resp.firewall_status.sync_states #=> Hash
resp.firewall_status.sync_states["AvailabilityZone"].attachment.subnet_id #=> String
resp.firewall_status.sync_states["AvailabilityZone"].attachment.endpoint_id #=> String
resp.firewall_status.sync_states["AvailabilityZone"].attachment.status #=> String, one of "CREATING", "DELETING", "FAILED", "ERROR", "SCALING", "READY"
resp.firewall_status.sync_states["AvailabilityZone"].attachment.status_message #=> String
resp.firewall_status.sync_states["AvailabilityZone"].config #=> Hash
resp.firewall_status.sync_states["AvailabilityZone"].config["ResourceName"].sync_status #=> String, one of "PENDING", "IN_SYNC", "CAPACITY_CONSTRAINED"
resp.firewall_status.sync_states["AvailabilityZone"].config["ResourceName"].update_token #=> String
resp.firewall_status.capacity_usage_summary.cid_rs.available_cidr_count #=> Integer
resp.firewall_status.capacity_usage_summary.cid_rs.utilized_cidr_count #=> Integer
resp.firewall_status.capacity_usage_summary.cid_rs.ip_set_references #=> Hash
resp.firewall_status.capacity_usage_summary.cid_rs.ip_set_references["IPSetArn"].resolved_cidr_count #=> Integer

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :firewall_name (required, String) —

    The descriptive name of the firewall. You can't change the name of a firewall after you create it.

  • :firewall_policy_arn (required, String) —

    The Amazon Resource Name (ARN) of the FirewallPolicy that you want to use for the firewall.

  • :vpc_id (String) —

    The unique identifier of the VPC where Network Firewall should create the firewall.

    You can't change this setting after you create the firewall.

  • :subnet_mappings (Array<Types::SubnetMapping>) —

    The public subnets to use for your Network Firewall firewalls. Each subnet must belong to a different Availability Zone in the VPC. Network Firewall creates a firewall endpoint in each subnet.

  • :delete_protection (Boolean) —

    A flag indicating whether it is possible to delete the firewall. A setting of TRUE indicates that the firewall is protected against deletion. Use this setting to protect against accidentally deleting a firewall that is in use. When you create a firewall, the operation initializes this flag to TRUE.

  • :subnet_change_protection (Boolean) —

    A setting indicating whether the firewall is protected against changes to the subnet associations. Use this setting to protect against accidentally modifying the subnet associations for a firewall that is in use. When you create a firewall, the operation initializes this setting to TRUE.

  • :firewall_policy_change_protection (Boolean) —

    A setting indicating whether the firewall is protected against a change to the firewall policy association. Use this setting to protect against accidentally modifying the firewall policy for a firewall that is in use. When you create a firewall, the operation initializes this setting to TRUE.

  • :description (String) —

    A description of the firewall.

  • :tags (Array<Types::Tag>) —

    The key:value pairs to associate with the resource.

  • :encryption_configuration (Types::EncryptionConfiguration) —

    A complex type that contains settings for encryption of your firewall resources.

  • :enabled_analysis_types (Array<String>) —

    An optional setting indicating the specific traffic analysis types to enable on the firewall.

Returns:

See Also:



789
790
791
792
 
# File 'gems/aws-sdk-networkfirewall/lib/aws-sdk-networkfirewall/client.rb', line 789

def create_firewall(params = {}, options = {})
  req = build_request(:create_firewall, params)
  req.send_request(options)
end

#create_firewall_policy(params = {}) ⇒ Types::CreateFirewallPolicyResponse

Creates the firewall policy for the firewall according to the specifications.

An Network Firewall firewall policy defines the behavior of a firewall, in a collection of stateless and stateful rule groups and other settings. You can use one firewall policy for multiple firewalls.

Examples:

Request syntax with placeholder values


resp = client.create_firewall_policy({
  firewall_policy_name: "ResourceName", # required
  firewall_policy: { # required
    stateless_rule_group_references: [
      {
        resource_arn: "ResourceArn", # required
        priority: 1, # required
      },
    ],
    stateless_default_actions: ["CollectionMember_String"], # required
    stateless_fragment_default_actions: ["CollectionMember_String"], # required
    stateless_custom_actions: [
      {
        action_name: "ActionName", # required
        action_definition: { # required
          publish_metric_action: {
            dimensions: [ # required
              {
                value: "DimensionValue", # required
              },
            ],
          },
        },
      },
    ],
    stateful_rule_group_references: [
      {
        resource_arn: "ResourceArn", # required
        priority: 1,
        override: {
          action: "DROP_TO_ALERT", # accepts DROP_TO_ALERT
        },
      },
    ],
    stateful_default_actions: ["CollectionMember_String"],
    stateful_engine_options: {
      rule_order: "DEFAULT_ACTION_ORDER", # accepts DEFAULT_ACTION_ORDER, STRICT_ORDER
      stream_exception_policy: "DROP", # accepts DROP, CONTINUE, REJECT
      flow_timeouts: {
        tcp_idle_timeout_seconds: 1,
      },
    },
    tls_inspection_configuration_arn: "ResourceArn",
    policy_variables: {
      rule_variables: {
        "RuleVariableName" => {
          definition: ["VariableDefinition"], # required
        },
      },
    },
  },
  description: "Description",
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
  dry_run: false,
  encryption_configuration: {
    key_id: "KeyId",
    type: "CUSTOMER_KMS", # required, accepts CUSTOMER_KMS, AWS_OWNED_KMS_KEY
  },
})

Response structure


resp.update_token #=> String
resp.firewall_policy_response.firewall_policy_name #=> String
resp.firewall_policy_response.firewall_policy_arn #=> String
resp.firewall_policy_response.firewall_policy_id #=> String
resp.firewall_policy_response.description #=> String
resp.firewall_policy_response.firewall_policy_status #=> String, one of "ACTIVE", "DELETING", "ERROR"
resp.firewall_policy_response.tags #=> Array
resp.firewall_policy_response.tags[0].key #=> String
resp.firewall_policy_response.tags[0].value #=> String
resp.firewall_policy_response.consumed_stateless_rule_capacity #=> Integer
resp.firewall_policy_response.consumed_stateful_rule_capacity #=> Integer
resp.firewall_policy_response.number_of_associations #=> Integer
resp.firewall_policy_response.encryption_configuration.key_id #=> String
resp.firewall_policy_response.encryption_configuration.type #=> String, one of "CUSTOMER_KMS", "AWS_OWNED_KMS_KEY"
resp.firewall_policy_response.last_modified_time #=> Time

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :firewall_policy_name (required, String) —

    The descriptive name of the firewall policy. You can't change the name of a firewall policy after you create it.

  • :firewall_policy (required, Types::FirewallPolicy) —

    The rule groups and policy actions to use in the firewall policy.

  • :description (String) —

    A description of the firewall policy.

  • :tags (Array<Types::Tag>) —

    The key:value pairs to associate with the resource.

  • :dry_run (Boolean) —

    Indicates whether you want Network Firewall to just check the validity of the request, rather than run the request.

    If set to TRUE, Network Firewall checks whether the request can run successfully, but doesn't actually make the requested changes. The call returns the value that the request would return if you ran it with dry run set to FALSE, but doesn't make additions or changes to your resources. This option allows you to make sure that you have the required permissions to run the request and that your request parameters are valid.

    If set to FALSE, Network Firewall makes the requested changes to your resources.

  • :encryption_configuration (Types::EncryptionConfiguration) —

    A complex type that contains settings for encryption of your firewall policy resources.

Returns:

See Also:



928
929
930
931
 
# File 'gems/aws-sdk-networkfirewall/lib/aws-sdk-networkfirewall/client.rb', line 928

def create_firewall_policy(params = {}, options = {})
  req = build_request(:create_firewall_policy, params)
  req.send_request(options)
end

#create_rule_group(params = {}) ⇒ Types::CreateRuleGroupResponse

Creates the specified stateless or stateful rule group, which includes the rules for network traffic inspection, a capacity setting, and tags.

You provide your rule group specification in your request using either RuleGroup or Rules.

Examples:

Request syntax with placeholder values


resp = client.create_rule_group({
  rule_group_name: "ResourceName", # required
  rule_group: {
    rule_variables: {
      ip_sets: {
        "RuleVariableName" => {
          definition: ["VariableDefinition"], # required
        },
      },
      port_sets: {
        "RuleVariableName" => {
          definition: ["VariableDefinition"],
        },
      },
    },
    reference_sets: {
      ip_set_references: {
        "IPSetReferenceName" => {
          reference_arn: "ResourceArn",
        },
      },
    },
    rules_source: { # required
      rules_string: "RulesString",
      rules_source_list: {
        targets: ["CollectionMember_String"], # required
        target_types: ["TLS_SNI"], # required, accepts TLS_SNI, HTTP_HOST
        generated_rules_type: "ALLOWLIST", # required, accepts ALLOWLIST, DENYLIST
      },
      stateful_rules: [
        {
          action: "PASS", # required, accepts PASS, DROP, ALERT, REJECT
          header: { # required
            protocol: "IP", # required, accepts IP, TCP, UDP, ICMP, HTTP, FTP, TLS, SMB, DNS, DCERPC, SSH, SMTP, IMAP, MSN, KRB5, IKEV2, TFTP, NTP, DHCP
            source: "Source", # required
            source_port: "Port", # required
            direction: "FORWARD", # required, accepts FORWARD, ANY
            destination: "Destination", # required
            destination_port: "Port", # required
          },
          rule_options: [ # required
            {
              keyword: "Keyword", # required
              settings: ["Setting"],
            },
          ],
        },
      ],
      stateless_rules_and_custom_actions: {
        stateless_rules: [ # required
          {
            rule_definition: { # required
              match_attributes: { # required
                sources: [
                  {
                    address_definition: "AddressDefinition", # required
                  },
                ],
                destinations: [
                  {
                    address_definition: "AddressDefinition", # required
                  },
                ],
                source_ports: [
                  {
                    from_port: 1, # required
                    to_port: 1, # required
                  },
                ],
                destination_ports: [
                  {
                    from_port: 1, # required
                    to_port: 1, # required
                  },
                ],
                protocols: [1],
                tcp_flags: [
                  {
                    flags: ["FIN"], # required, accepts FIN, SYN, RST, PSH, ACK, URG, ECE, CWR
                    masks: ["FIN"], # accepts FIN, SYN, RST, PSH, ACK, URG, ECE, CWR
                  },
                ],
              },
              actions: ["CollectionMember_String"], # required
            },
            priority: 1, # required
          },
        ],
        custom_actions: [
          {
            action_name: "ActionName", # required
            action_definition: { # required
              publish_metric_action: {
                dimensions: [ # required
                  {
                    value: "DimensionValue", # required
                  },
                ],
              },
            },
          },
        ],
      },
    },
    stateful_rule_options: {
      rule_order: "DEFAULT_ACTION_ORDER", # accepts DEFAULT_ACTION_ORDER, STRICT_ORDER
    },
  },
  rules: "RulesString",
  type: "STATELESS", # required, accepts STATELESS, STATEFUL
  description: "Description",
  capacity: 1, # required
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
  dry_run: false,
  encryption_configuration: {
    key_id: "KeyId",
    type: "CUSTOMER_KMS", # required, accepts CUSTOMER_KMS, AWS_OWNED_KMS_KEY
  },
  source_metadata: {
    source_arn: "ResourceArn",
    source_update_token: "UpdateToken",
  },
  analyze_rule_group: false,
})

Response structure


resp.update_token #=> String
resp.rule_group_response.rule_group_arn #=> String
resp.rule_group_response.rule_group_name #=> String
resp.rule_group_response.rule_group_id #=> String
resp.rule_group_response.description #=> String
resp.rule_group_response.type #=> String, one of "STATELESS", "STATEFUL"
resp.rule_group_response.capacity #=> Integer
resp.rule_group_response.rule_group_status #=> String, one of "ACTIVE", "DELETING", "ERROR"
resp.rule_group_response.tags #=> Array
resp.rule_group_response.tags[0].key #=> String
resp.rule_group_response.tags[0].value #=> String
resp.rule_group_response.consumed_capacity #=> Integer
resp.rule_group_response.number_of_associations #=> Integer
resp.rule_group_response.encryption_configuration.key_id #=> String
resp.rule_group_response.encryption_configuration.type #=> String, one of "CUSTOMER_KMS", "AWS_OWNED_KMS_KEY"
resp.rule_group_response.source_metadata.source_arn #=> String
resp.rule_group_response.source_metadata.source_update_token #=> String
resp.rule_group_response.sns_topic #=> String
resp.rule_group_response.last_modified_time #=> Time
resp.rule_group_response.analysis_results #=> Array
resp.rule_group_response.analysis_results[0].identified_rule_ids #=> Array
resp.rule_group_response.analysis_results[0].identified_rule_ids[0] #=> String
resp.rule_group_response.analysis_results[0].identified_type #=> String, one of "STATELESS_RULE_FORWARDING_ASYMMETRICALLY", "STATELESS_RULE_CONTAINS_TCP_FLAGS"
resp.rule_group_response.analysis_results[0].analysis_detail #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :rule_group_name (required, String) —

    The descriptive name of the rule group. You can't change the name of a rule group after you create it.

  • :rule_group (Types::RuleGroup) —

    An object that defines the rule group rules.

    You must provide either this rule group setting or a Rules setting, but not both.

  • :rules (String) —

    A string containing stateful rule group rules specifications in Suricata flat format, with one rule per line. Use this to import your existing Suricata compatible rule groups.

    You must provide either this rules setting or a populated RuleGroup setting, but not both.

    You can provide your rule group specification in Suricata flat format through this setting when you create or update your rule group. The call response returns a RuleGroup object that Network Firewall has populated from your string.

  • :type (required, String) —

    Indicates whether the rule group is stateless or stateful. If the rule group is stateless, it contains stateless rules. If it is stateful, it contains stateful rules.

  • :description (String) —

    A description of the rule group.

  • :capacity (required, Integer) —

    The maximum operating resources that this rule group can use. Rule group capacity is fixed at creation. When you update a rule group, you are limited to this capacity. When you reference a rule group from a firewall policy, Network Firewall reserves this capacity for the rule group.

    You can retrieve the capacity that would be required for a rule group before you create the rule group by calling CreateRuleGroup with DryRun set to TRUE.

    You can't change or exceed this capacity when you update the rule group, so leave room for your rule group to grow.

    Capacity for a stateless rule group

    For a stateless rule group, the capacity required is the sum of the capacity requirements of the individual rules that you expect to have in the rule group.

    To calculate the capacity requirement of a single rule, multiply the capacity requirement values of each of the rule's match settings:

    • A match setting with no criteria specified has a value of 1.

    • A match setting with Any specified has a value of 1.

    • All other match settings have a value equal to the number of elements provided in the setting. For example, a protocol setting ["UDP"] and a source setting ["10.0.0.0/24"] each have a value of 1. A protocol setting ["UDP","TCP"] has a value of 2. A source setting ["10.0.0.0/24","10.0.0.1/24","10.0.0.2/24"] has a value of 3.

    A rule with no criteria specified in any of its match settings has a capacity requirement of 1. A rule with protocol setting ["UDP","TCP"], source setting ["10.0.0.0/24","10.0.0.1/24","10.0.0.2/24"], and a single specification or no specification for each of the other match settings has a capacity requirement of 6.

    Capacity for a stateful rule group

    For a stateful rule group, the minimum capacity required is the number of individual rules that you expect to have in the rule group.

  • :tags (Array<Types::Tag>) —

    The key:value pairs to associate with the resource.

  • :dry_run (Boolean) —

    Indicates whether you want Network Firewall to just check the validity of the request, rather than run the request.

    If set to TRUE, Network Firewall checks whether the request can run successfully, but doesn't actually make the requested changes. The call returns the value that the request would return if you ran it with dry run set to FALSE, but doesn't make additions or changes to your resources. This option allows you to make sure that you have the required permissions to run the request and that your request parameters are valid.

    If set to FALSE, Network Firewall makes the requested changes to your resources.

  • :encryption_configuration (Types::EncryptionConfiguration) —

    A complex type that contains settings for encryption of your rule group resources.

  • :source_metadata (Types::SourceMetadata) —

    A complex type that contains metadata about the rule group that your own rule group is copied from. You can use the metadata to keep track of updates made to the originating rule group.

  • :analyze_rule_group (Boolean) —

    Indicates whether you want Network Firewall to analyze the stateless rules in the rule group for rule behavior such as asymmetric routing. If set to TRUE, Network Firewall runs the analysis and then creates the rule group for you. To run the stateless rule group analyzer without creating the rule group, set DryRun to TRUE.

Returns:

See Also:



1225
1226
1227
1228
 
# File 'gems/aws-sdk-networkfirewall/lib/aws-sdk-networkfirewall/client.rb', line 1225

def create_rule_group(params = {}, options = {})
  req = build_request(:create_rule_group, params)
  req.send_request(options)
end

#create_tls_inspection_configuration(params = {}) ⇒ Types::CreateTLSInspectionConfigurationResponse

Creates an Network Firewall TLS inspection configuration. Network Firewall uses TLS inspection configurations to decrypt your firewall's inbound and outbound SSL/TLS traffic. After decryption, Network Firewall inspects the traffic according to your firewall policy's stateful rules, and then re-encrypts it before sending it to its destination. You can enable inspection of your firewall's inbound traffic, outbound traffic, or both. To use TLS inspection with your firewall, you must first import or provision certificates using ACM, create a TLS inspection configuration, add that configuration to a new firewall policy, and then associate that policy with your firewall.

To update the settings for a TLS inspection configuration, use UpdateTLSInspectionConfiguration.

To manage a TLS inspection configuration's tags, use the standard Amazon Web Services resource tagging operations, ListTagsForResource, TagResource, and UntagResource.

To retrieve information about TLS inspection configurations, use ListTLSInspectionConfigurations and DescribeTLSInspectionConfiguration.

For more information about TLS inspection configurations, see Inspecting SSL/TLS traffic with TLS inspection configurations in the Network Firewall Developer Guide.

Examples:

Request syntax with placeholder values


resp = client.create_tls_inspection_configuration({
  tls_inspection_configuration_name: "ResourceName", # required
  tls_inspection_configuration: { # required
    server_certificate_configurations: [
      {
        server_certificates: [
          {
            resource_arn: "ResourceArn",
          },
        ],
        scopes: [
          {
            sources: [
              {
                address_definition: "AddressDefinition", # required
              },
            ],
            destinations: [
              {
                address_definition: "AddressDefinition", # required
              },
            ],
            source_ports: [
              {
                from_port: 1, # required
                to_port: 1, # required
              },
            ],
            destination_ports: [
              {
                from_port: 1, # required
                to_port: 1, # required
              },
            ],
            protocols: [1],
          },
        ],
        certificate_authority_arn: "ResourceArn",
        check_certificate_revocation_status: {
          revoked_status_action: "PASS", # accepts PASS, DROP, REJECT
          unknown_status_action: "PASS", # accepts PASS, DROP, REJECT
        },
      },
    ],
  },
  description: "Description",
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
  encryption_configuration: {
    key_id: "KeyId",
    type: "CUSTOMER_KMS", # required, accepts CUSTOMER_KMS, AWS_OWNED_KMS_KEY
  },
})

Response structure


resp.update_token #=> String
resp.tls_inspection_configuration_response.tls_inspection_configuration_arn #=> String
resp.tls_inspection_configuration_response.tls_inspection_configuration_name #=> String
resp.tls_inspection_configuration_response.tls_inspection_configuration_id #=> String
resp.tls_inspection_configuration_response.tls_inspection_configuration_status #=> String, one of "ACTIVE", "DELETING", "ERROR"
resp.tls_inspection_configuration_response.description #=> String
resp.tls_inspection_configuration_response.tags #=> Array
resp.tls_inspection_configuration_response.tags[0].key #=> String
resp.tls_inspection_configuration_response.tags[0].value #=> String
resp.tls_inspection_configuration_response.last_modified_time #=> Time
resp.tls_inspection_configuration_response.number_of_associations #=> Integer
resp.tls_inspection_configuration_response.encryption_configuration.key_id #=> String
resp.tls_inspection_configuration_response.encryption_configuration.type #=> String, one of "CUSTOMER_KMS", "AWS_OWNED_KMS_KEY"
resp.tls_inspection_configuration_response.certificates #=> Array
resp.tls_inspection_configuration_response.certificates[0].certificate_arn #=> String
resp.tls_inspection_configuration_response.certificates[0].certificate_serial #=> String
resp.tls_inspection_configuration_response.certificates[0].status #=> String
resp.tls_inspection_configuration_response.certificates[0].status_message #=> String
resp.tls_inspection_configuration_response.certificate_authority.certificate_arn #=> String
resp.tls_inspection_configuration_response.certificate_authority.certificate_serial #=> String
resp.tls_inspection_configuration_response.certificate_authority.status #=> String
resp.tls_inspection_configuration_response.certificate_authority.status_message #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :tls_inspection_configuration_name (required, String) —

    The descriptive name of the TLS inspection configuration. You can't change the name of a TLS inspection configuration after you create it.

  • :tls_inspection_configuration (required, Types::TLSInspectionConfiguration) —

    The object that defines a TLS inspection configuration. This, along with TLSInspectionConfigurationResponse, define the TLS inspection configuration. You can retrieve all objects for a TLS inspection configuration by calling DescribeTLSInspectionConfiguration.

    Network Firewall uses a TLS inspection configuration to decrypt traffic. Network Firewall re-encrypts the traffic before sending it to its destination.

    To use a TLS inspection configuration, you add it to a new Network Firewall firewall policy, then you apply the firewall policy to a firewall. Network Firewall acts as a proxy service to decrypt and inspect the traffic traveling through your firewalls. You can reference a TLS inspection configuration from more than one firewall policy, and you can use a firewall policy in more than one firewall. For more information about using TLS inspection configurations, see Inspecting SSL/TLS traffic with TLS inspection configurations in the Network Firewall Developer Guide.

  • :description (String) —

    A description of the TLS inspection configuration.

  • :tags (Array<Types::Tag>) —

    The key:value pairs to associate with the resource.

  • :encryption_configuration (Types::EncryptionConfiguration) —

    A complex type that contains optional Amazon Web Services Key Management Service (KMS) encryption settings for your Network Firewall resources. Your data is encrypted by default with an Amazon Web Services owned key that Amazon Web Services owns and manages for you. You can use either the Amazon Web Services owned key, or provide your own customer managed key. To learn more about KMS encryption of your Network Firewall resources, see Encryption at rest with Amazon Web Services Key Managment Service in the Network Firewall Developer Guide.

Returns:

See Also:



1403
1404
1405
1406
 
# File 'gems/aws-sdk-networkfirewall/lib/aws-sdk-networkfirewall/client.rb', line 1403

def create_tls_inspection_configuration(params = {}, options = {})
  req = build_request(:create_tls_inspection_configuration, params)
  req.send_request(options)
end

#delete_firewall(params = {}) ⇒ Types::DeleteFirewallResponse

Deletes the specified Firewall and its FirewallStatus. This operation requires the firewall's DeleteProtection flag to be FALSE. You can't revert this operation.

You can check whether a firewall is in use by reviewing the route tables for the Availability Zones where you have firewall subnet mappings. Retrieve the subnet mappings by calling DescribeFirewall. You define and update the route tables through Amazon VPC. As needed, update the route tables for the zones to remove the firewall endpoints. When the route tables no longer use the firewall endpoints, you can remove the firewall safely.

To delete a firewall, remove the delete protection if you need to using UpdateFirewallDeleteProtection, then delete the firewall by calling DeleteFirewall.

Examples:

Request syntax with placeholder values


resp = client.delete_firewall({
  firewall_name: "ResourceName",
  firewall_arn: "ResourceArn",
})

Response structure


resp.firewall.firewall_name #=> String
resp.firewall.firewall_arn #=> String
resp.firewall.firewall_policy_arn #=> String
resp.firewall.vpc_id #=> String
resp.firewall.subnet_mappings #=> Array
resp.firewall.subnet_mappings[0].subnet_id #=> String
resp.firewall.subnet_mappings[0].ip_address_type #=> String, one of "DUALSTACK", "IPV4", "IPV6"
resp.firewall.delete_protection #=> Boolean
resp.firewall.subnet_change_protection #=> Boolean
resp.firewall.firewall_policy_change_protection #=> Boolean
resp.firewall.description #=> String
resp.firewall.firewall_id #=> String
resp.firewall.tags #=> Array
resp.firewall.tags[0].key #=> String
resp.firewall.tags[0].value #=> String
resp.firewall.encryption_configuration.key_id #=> String
resp.firewall.encryption_configuration.type #=> String, one of "CUSTOMER_KMS", "AWS_OWNED_KMS_KEY"
resp.firewall.enabled_analysis_types #=> Array
resp.firewall.enabled_analysis_types[0] #=> String, one of "TLS_SNI", "HTTP_HOST"
resp.firewall_status.status #=> String, one of "PROVISIONING", "DELETING", "READY"
resp.firewall_status.configuration_sync_state_summary #=> String, one of "PENDING", "IN_SYNC", "CAPACITY_CONSTRAINED"
resp.firewall_status.sync_states #=> Hash
resp.firewall_status.sync_states["AvailabilityZone"].attachment.subnet_id #=> String
resp.firewall_status.sync_states["AvailabilityZone"].attachment.endpoint_id #=> String
resp.firewall_status.sync_states["AvailabilityZone"].attachment.status #=> String, one of "CREATING", "DELETING", "FAILED", "ERROR", "SCALING", "READY"
resp.firewall_status.sync_states["AvailabilityZone"].attachment.status_message #=> String
resp.firewall_status.sync_states["AvailabilityZone"].config #=> Hash
resp.firewall_status.sync_states["AvailabilityZone"].config["ResourceName"].sync_status #=> String, one of "PENDING", "IN_SYNC", "CAPACITY_CONSTRAINED"
resp.firewall_status.sync_states["AvailabilityZone"].config["ResourceName"].update_token #=> String
resp.firewall_status.capacity_usage_summary.cid_rs.available_cidr_count #=> Integer
resp.firewall_status.capacity_usage_summary.cid_rs.utilized_cidr_count #=> Integer
resp.firewall_status.capacity_usage_summary.cid_rs.ip_set_references #=> Hash
resp.firewall_status.capacity_usage_summary.cid_rs.ip_set_references["IPSetArn"].resolved_cidr_count #=> Integer

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :firewall_name (String) —

    The descriptive name of the firewall. You can't change the name of a firewall after you create it.

    You must specify the ARN or the name, and you can specify both.

  • :firewall_arn (String) —

    The Amazon Resource Name (ARN) of the firewall.

    You must specify the ARN or the name, and you can specify both.

Returns:

See Also:



1487
1488
1489
1490
 
# File 'gems/aws-sdk-networkfirewall/lib/aws-sdk-networkfirewall/client.rb', line 1487

def delete_firewall(params = {}, options = {})
  req = build_request(:delete_firewall, params)
  req.send_request(options)
end

#delete_firewall_policy(params = {}) ⇒ Types::DeleteFirewallPolicyResponse

Deletes the specified FirewallPolicy.

Examples:

Request syntax with placeholder values


resp = client.delete_firewall_policy({
  firewall_policy_name: "ResourceName",
  firewall_policy_arn: "ResourceArn",
})

Response structure


resp.firewall_policy_response.firewall_policy_name #=> String
resp.firewall_policy_response.firewall_policy_arn #=> String
resp.firewall_policy_response.firewall_policy_id #=> String
resp.firewall_policy_response.description #=> String
resp.firewall_policy_response.firewall_policy_status #=> String, one of "ACTIVE", "DELETING", "ERROR"
resp.firewall_policy_response.tags #=> Array
resp.firewall_policy_response.tags[0].key #=> String
resp.firewall_policy_response.tags[0].value #=> String
resp.firewall_policy_response.consumed_stateless_rule_capacity #=> Integer
resp.firewall_policy_response.consumed_stateful_rule_capacity #=> Integer
resp.firewall_policy_response.number_of_associations #=> Integer
resp.firewall_policy_response.encryption_configuration.key_id #=> String
resp.firewall_policy_response.encryption_configuration.type #=> String, one of "CUSTOMER_KMS", "AWS_OWNED_KMS_KEY"
resp.firewall_policy_response.last_modified_time #=> Time

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :firewall_policy_name (String) —

    The descriptive name of the firewall policy. You can't change the name of a firewall policy after you create it.

    You must specify the ARN or the name, and you can specify both.

  • :firewall_policy_arn (String) —

    The Amazon Resource Name (ARN) of the firewall policy.

    You must specify the ARN or the name, and you can specify both.

Returns:

See Also:



1537
1538
1539
1540
 
# File 'gems/aws-sdk-networkfirewall/lib/aws-sdk-networkfirewall/client.rb', line 1537

def delete_firewall_policy(params = {}, options = {})
  req = build_request(:delete_firewall_policy, params)
  req.send_request(options)
end

#delete_resource_policy(params = {}) ⇒ Struct

Deletes a resource policy that you created in a PutResourcePolicy request.

Examples:

Request syntax with placeholder values


resp = client.delete_resource_policy({
  resource_arn: "ResourceArn", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

    The Amazon Resource Name (ARN) of the rule group or firewall policy whose resource policy you want to delete.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1561
1562
1563
1564
 
# File 'gems/aws-sdk-networkfirewall/lib/aws-sdk-networkfirewall/client.rb', line 1561

def delete_resource_policy(params = {}, options = {})
  req = build_request(:delete_resource_policy, params)
  req.send_request(options)
end

#delete_rule_group(params = {}) ⇒ Types::DeleteRuleGroupResponse

Deletes the specified RuleGroup.

Examples:

Request syntax with placeholder values


resp = client.delete_rule_group({
  rule_group_name: "ResourceName",
  rule_group_arn: "ResourceArn",
  type: "STATELESS", # accepts STATELESS, STATEFUL
})

Response structure


resp.rule_group_response.rule_group_arn #=> String
resp.rule_group_response.rule_group_name #=> String
resp.rule_group_response.rule_group_id #=> String
resp.rule_group_response.description #=> String
resp.rule_group_response.type #=> String, one of "STATELESS", "STATEFUL"
resp.rule_group_response.capacity #=> Integer
resp.rule_group_response.rule_group_status #=> String, one of "ACTIVE", "DELETING", "ERROR"
resp.rule_group_response.tags #=> Array
resp.rule_group_response.tags[0].key #=> String
resp.rule_group_response.tags[0].value #=> String
resp.rule_group_response.consumed_capacity #=> Integer
resp.rule_group_response.number_of_associations #=> Integer
resp.rule_group_response.encryption_configuration.key_id #=> String
resp.rule_group_response.encryption_configuration.type #=> String, one of "CUSTOMER_KMS", "AWS_OWNED_KMS_KEY"
resp.rule_group_response.source_metadata.source_arn #=> String
resp.rule_group_response.source_metadata.source_update_token #=> String
resp.rule_group_response.sns_topic #=> String
resp.rule_group_response.last_modified_time #=> Time
resp.rule_group_response.analysis_results #=> Array
resp.rule_group_response.analysis_results[0].identified_rule_ids #=> Array
resp.rule_group_response.analysis_results[0].identified_rule_ids[0] #=> String
resp.rule_group_response.analysis_results[0].identified_type #=> String, one of "STATELESS_RULE_FORWARDING_ASYMMETRICALLY", "STATELESS_RULE_CONTAINS_TCP_FLAGS"
resp.rule_group_response.analysis_results[0].analysis_detail #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :rule_group_name (String) —

    The descriptive name of the rule group. You can't change the name of a rule group after you create it.

    You must specify the ARN or the name, and you can specify both.

  • :rule_group_arn (String) —

    The Amazon Resource Name (ARN) of the rule group.

    You must specify the ARN or the name, and you can specify both.

  • :type (String) —

    Indicates whether the rule group is stateless or stateful. If the rule group is stateless, it contains stateless rules. If it is stateful, it contains stateful rules.

    This setting is required for requests that do not include the RuleGroupARN.

Returns:

See Also:



1631
1632
1633
1634
 
# File 'gems/aws-sdk-networkfirewall/lib/aws-sdk-networkfirewall/client.rb', line 1631

def delete_rule_group(params = {}, options = {})
  req = build_request(:delete_rule_group, params)
  req.send_request(options)
end

#delete_tls_inspection_configuration(params = {}) ⇒ Types::DeleteTLSInspectionConfigurationResponse

Deletes the specified TLSInspectionConfiguration.

Examples:

Request syntax with placeholder values


resp = client.delete_tls_inspection_configuration({
  tls_inspection_configuration_arn: "ResourceArn",
  tls_inspection_configuration_name: "ResourceName",
})

Response structure


resp.tls_inspection_configuration_response.tls_inspection_configuration_arn #=> String
resp.tls_inspection_configuration_response.tls_inspection_configuration_name #=> String
resp.tls_inspection_configuration_response.tls_inspection_configuration_id #=> String
resp.tls_inspection_configuration_response.tls_inspection_configuration_status #=> String, one of "ACTIVE", "DELETING", "ERROR"
resp.tls_inspection_configuration_response.description #=> String
resp.tls_inspection_configuration_response.tags #=> Array
resp.tls_inspection_configuration_response.tags[0].key #=> String
resp.tls_inspection_configuration_response.tags[0].value #=> String
resp.tls_inspection_configuration_response.last_modified_time #=> Time
resp.tls_inspection_configuration_response.number_of_associations #=> Integer
resp.tls_inspection_configuration_response.encryption_configuration.key_id #=> String
resp.tls_inspection_configuration_response.encryption_configuration.type #=> String, one of "CUSTOMER_KMS", "AWS_OWNED_KMS_KEY"
resp.tls_inspection_configuration_response.certificates #=> Array
resp.tls_inspection_configuration_response.certificates[0].certificate_arn #=> String
resp.tls_inspection_configuration_response.certificates[0].certificate_serial #=> String
resp.tls_inspection_configuration_response.certificates[0].status #=> String
resp.tls_inspection_configuration_response.certificates[0].status_message #=> String
resp.tls_inspection_configuration_response.certificate_authority.certificate_arn #=> String
resp.tls_inspection_configuration_response.certificate_authority.certificate_serial #=> String
resp.tls_inspection_configuration_response.certificate_authority.status #=> String
resp.tls_inspection_configuration_response.certificate_authority.status_message #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :tls_inspection_configuration_arn (String) —

    The Amazon Resource Name (ARN) of the TLS inspection configuration.

    You must specify the ARN or the name, and you can specify both.

  • :tls_inspection_configuration_name (String) —

    The descriptive name of the TLS inspection configuration. You can't change the name of a TLS inspection configuration after you create it.

    You must specify the ARN or the name, and you can specify both.

Returns:

See Also:



1688
1689
1690
1691
 
# File 'gems/aws-sdk-networkfirewall/lib/aws-sdk-networkfirewall/client.rb', line 1688

def delete_tls_inspection_configuration(params = {}, options = {})
  req = build_request(:delete_tls_inspection_configuration, params)
  req.send_request(options)
end

#describe_firewall(params = {}) ⇒ Types::DescribeFirewallResponse

Returns the data objects for the specified firewall.

Examples:

Request syntax with placeholder values


resp = client.describe_firewall({
  firewall_name: "ResourceName",
  firewall_arn: "ResourceArn",
})

Response structure


resp.update_token #=> String
resp.firewall.firewall_name #=> String
resp.firewall.firewall_arn #=> String
resp.firewall.firewall_policy_arn #=> String
resp.firewall.vpc_id #=> String
resp.firewall.subnet_mappings #=> Array
resp.firewall.subnet_mappings[0].subnet_id #=> String
resp.firewall.subnet_mappings[0].ip_address_type #=> String, one of "DUALSTACK", "IPV4", "IPV6"
resp.firewall.delete_protection #=> Boolean
resp.firewall.subnet_change_protection #=> Boolean
resp.firewall.firewall_policy_change_protection #=> Boolean
resp.firewall.description #=> String
resp.firewall.firewall_id #=> String
resp.firewall.tags #=> Array
resp.firewall.tags[0].key #=> String
resp.firewall.tags[0].value #=> String
resp.firewall.encryption_configuration.key_id #=> String
resp.firewall.encryption_configuration.type #=> String, one of "CUSTOMER_KMS", "AWS_OWNED_KMS_KEY"
resp.firewall.enabled_analysis_types #=> Array
resp.firewall.enabled_analysis_types[0] #=> String, one of "TLS_SNI", "HTTP_HOST"
resp.firewall_status.status #=> String, one of "PROVISIONING", "DELETING", "READY"
resp.firewall_status.configuration_sync_state_summary #=> String, one of "PENDING", "IN_SYNC", "CAPACITY_CONSTRAINED"
resp.firewall_status.sync_states #=> Hash
resp.firewall_status.sync_states["AvailabilityZone"].attachment.subnet_id #=> String
resp.firewall_status.sync_states["AvailabilityZone"].attachment.endpoint_id #=> String
resp.firewall_status.sync_states["AvailabilityZone"].attachment.status #=> String, one of "CREATING", "DELETING", "FAILED", "ERROR", "SCALING", "READY"
resp.firewall_status.sync_states["AvailabilityZone"].attachment.status_message #=> String
resp.firewall_status.sync_states["AvailabilityZone"].config #=> Hash
resp.firewall_status.sync_states["AvailabilityZone"].config["ResourceName"].sync_status #=> String, one of "PENDING", "IN_SYNC", "CAPACITY_CONSTRAINED"
resp.firewall_status.sync_states["AvailabilityZone"].config["ResourceName"].update_token #=> String
resp.firewall_status.capacity_usage_summary.cid_rs.available_cidr_count #=> Integer
resp.firewall_status.capacity_usage_summary.cid_rs.utilized_cidr_count #=> Integer
resp.firewall_status.capacity_usage_summary.cid_rs.ip_set_references #=> Hash
resp.firewall_status.capacity_usage_summary.cid_rs.ip_set_references["IPSetArn"].resolved_cidr_count #=> Integer

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :firewall_name (String) —

    The descriptive name of the firewall. You can't change the name of a firewall after you create it.

    You must specify the ARN or the name, and you can specify both.

  • :firewall_arn (String) —

    The Amazon Resource Name (ARN) of the firewall.

    You must specify the ARN or the name, and you can specify both.

Returns:

See Also:



1760
1761
1762
1763
 
# File 'gems/aws-sdk-networkfirewall/lib/aws-sdk-networkfirewall/client.rb', line 1760

def describe_firewall(params = {}, options = {})
  req = build_request(:describe_firewall, params)
  req.send_request(options)
end

#describe_firewall_policy(params = {}) ⇒ Types::DescribeFirewallPolicyResponse

Returns the data objects for the specified firewall policy.

Examples:

Request syntax with placeholder values


resp = client.describe_firewall_policy({
  firewall_policy_name: "ResourceName",
  firewall_policy_arn: "ResourceArn",
})

Response structure


resp.update_token #=> String
resp.firewall_policy_response.firewall_policy_name #=> String
resp.firewall_policy_response.firewall_policy_arn #=> String
resp.firewall_policy_response.firewall_policy_id #=> String
resp.firewall_policy_response.description #=> String
resp.firewall_policy_response.firewall_policy_status #=> String, one of "ACTIVE", "DELETING", "ERROR"
resp.firewall_policy_response.tags #=> Array
resp.firewall_policy_response.tags[0].key #=> String
resp.firewall_policy_response.tags[0].value #=> String
resp.firewall_policy_response.consumed_stateless_rule_capacity #=> Integer
resp.firewall_policy_response.consumed_stateful_rule_capacity #=> Integer
resp.firewall_policy_response.number_of_associations #=> Integer
resp.firewall_policy_response.encryption_configuration.key_id #=> String
resp.firewall_policy_response.encryption_configuration.type #=> String, one of "CUSTOMER_KMS", "AWS_OWNED_KMS_KEY"
resp.firewall_policy_response.last_modified_time #=> Time
resp.firewall_policy.stateless_rule_group_references #=> Array
resp.firewall_policy.stateless_rule_group_references[0].resource_arn #=> String
resp.firewall_policy.stateless_rule_group_references[0].priority #=> Integer
resp.firewall_policy.stateless_default_actions #=> Array
resp.firewall_policy.stateless_default_actions[0] #=> String
resp.firewall_policy.stateless_fragment_default_actions #=> Array
resp.firewall_policy.stateless_fragment_default_actions[0] #=> String
resp.firewall_policy.stateless_custom_actions #=> Array
resp.firewall_policy.stateless_custom_actions[0].action_name #=> String
resp.firewall_policy.stateless_custom_actions[0].action_definition.publish_metric_action.dimensions #=> Array
resp.firewall_policy.stateless_custom_actions[0].action_definition.publish_metric_action.dimensions[0].value #=> String
resp.firewall_policy.stateful_rule_group_references #=> Array
resp.firewall_policy.stateful_rule_group_references[0].resource_arn #=> String
resp.firewall_policy.stateful_rule_group_references[0].priority #=> Integer
resp.firewall_policy.stateful_rule_group_references[0].override.action #=> String, one of "DROP_TO_ALERT"
resp.firewall_policy.stateful_default_actions #=> Array
resp.firewall_policy.stateful_default_actions[0] #=> String
resp.firewall_policy.stateful_engine_options.rule_order #=> String, one of "DEFAULT_ACTION_ORDER", "STRICT_ORDER"
resp.firewall_policy.stateful_engine_options.stream_exception_policy #=> String, one of "DROP", "CONTINUE", "REJECT"
resp.firewall_policy.stateful_engine_options.flow_timeouts.tcp_idle_timeout_seconds #=> Integer
resp.firewall_policy.tls_inspection_configuration_arn #=> String
resp.firewall_policy.policy_variables.rule_variables #=> Hash
resp.firewall_policy.policy_variables.rule_variables["RuleVariableName"].definition #=> Array
resp.firewall_policy.policy_variables.rule_variables["RuleVariableName"].definition[0] #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :firewall_policy_name (String) —

    The descriptive name of the firewall policy. You can't change the name of a firewall policy after you create it.

    You must specify the ARN or the name, and you can specify both.

  • :firewall_policy_arn (String) —

    The Amazon Resource Name (ARN) of the firewall policy.

    You must specify the ARN or the name, and you can specify both.

Returns:

See Also:



1837
1838
1839
1840
 
# File 'gems/aws-sdk-networkfirewall/lib/aws-sdk-networkfirewall/client.rb', line 1837

def describe_firewall_policy(params = {}, options = {})
  req = build_request(:describe_firewall_policy, params)
  req.send_request(options)
end

#describe_flow_operation(params = {}) ⇒ Types::DescribeFlowOperationResponse

Returns key information about a specific flow operation.

Examples:

Request syntax with placeholder values


resp = client.describe_flow_operation({
  firewall_arn: "ResourceArn", # required
  availability_zone: "AvailabilityZone",
  flow_operation_id: "FlowOperationId", # required
})

Response structure


resp.firewall_arn #=> String
resp.availability_zone #=> String
resp.flow_operation_id #=> String
resp.flow_operation_type #=> String, one of "FLOW_FLUSH", "FLOW_CAPTURE"
resp.flow_operation_status #=> String, one of "COMPLETED", "IN_PROGRESS", "FAILED", "COMPLETED_WITH_ERRORS"
resp.status_message #=> String
resp.flow_request_timestamp #=> Time
resp.flow_operation.minimum_flow_age_in_seconds #=> Integer
resp.flow_operation.flow_filters #=> Array
resp.flow_operation.flow_filters[0].source_address.address_definition #=> String
resp.flow_operation.flow_filters[0].destination_address.address_definition #=> String
resp.flow_operation.flow_filters[0].source_port #=> String
resp.flow_operation.flow_filters[0].destination_port #=> String
resp.flow_operation.flow_filters[0].protocols #=> Array
resp.flow_operation.flow_filters[0].protocols[0] #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :firewall_arn (required, String) —

    The Amazon Resource Name (ARN) of the firewall.

  • :availability_zone (String) —

    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.

  • :flow_operation_id (required, String) —

    A unique identifier for the flow operation. This ID is returned in the responses to start and list commands. You provide to describe commands.

Returns:

See Also:



1900
1901
1902
1903
 
# File 'gems/aws-sdk-networkfirewall/lib/aws-sdk-networkfirewall/client.rb', line 1900

def describe_flow_operation(params = {}, options = {})
  req = build_request(:describe_flow_operation, params)
  req.send_request(options)
end

#describe_logging_configuration(params = {}) ⇒ Types::DescribeLoggingConfigurationResponse

Returns the logging configuration for the specified firewall.

Examples:

Request syntax with placeholder values


resp = client.describe_logging_configuration({
  firewall_arn: "ResourceArn",
  firewall_name: "ResourceName",
})

Response structure


resp.firewall_arn #=> String
resp.logging_configuration.log_destination_configs #=> Array
resp.logging_configuration.log_destination_configs[0].log_type #=> String, one of "ALERT", "FLOW", "TLS"
resp.logging_configuration.log_destination_configs[0].log_destination_type #=> String, one of "S3", "CloudWatchLogs", "KinesisDataFirehose"
resp.logging_configuration.log_destination_configs[0].log_destination #=> Hash
resp.logging_configuration.log_destination_configs[0].log_destination["HashMapKey"] #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :firewall_arn (String) —

    The Amazon Resource Name (ARN) of the firewall.

    You must specify the ARN or the name, and you can specify both.

  • :firewall_name (String) —

    The descriptive name of the firewall. You can't change the name of a firewall after you create it.

    You must specify the ARN or the name, and you can specify both.

Returns:

See Also:



1943
1944
1945
1946
 
# File 'gems/aws-sdk-networkfirewall/lib/aws-sdk-networkfirewall/client.rb', line 1943

def describe_logging_configuration(params = {}, options = {})
  req = build_request(:describe_logging_configuration, params)
  req.send_request(options)
end

#describe_resource_policy(params = {}) ⇒ Types::DescribeResourcePolicyResponse

Retrieves a resource policy that you created in a PutResourcePolicy request.

Examples:

Request syntax with placeholder values


resp = client.describe_resource_policy({
  resource_arn: "ResourceArn", # required
})

Response structure


resp.policy #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

    The Amazon Resource Name (ARN) of the rule group or firewall policy whose resource policy you want to retrieve.

Returns:

See Also:



1973
1974
1975
1976
 
# File 'gems/aws-sdk-networkfirewall/lib/aws-sdk-networkfirewall/client.rb', line 1973

def describe_resource_policy(params = {}, options = {})
  req = build_request(:describe_resource_policy, params)
  req.send_request(options)
end

#describe_rule_group(params = {}) ⇒ Types::DescribeRuleGroupResponse

Returns the data objects for the specified rule group.

Examples:

Request syntax with placeholder values


resp = client.describe_rule_group({
  rule_group_name: "ResourceName",
  rule_group_arn: "ResourceArn",
  type: "STATELESS", # accepts STATELESS, STATEFUL
  analyze_rule_group: false,
})

Response structure


resp.update_token #=> String
resp.rule_group.rule_variables.ip_sets #=> Hash
resp.rule_group.rule_variables.ip_sets["RuleVariableName"].definition #=> Array
resp.rule_group.rule_variables.ip_sets["RuleVariableName"].definition[0] #=> String
resp.rule_group.rule_variables.port_sets #=> Hash
resp.rule_group.rule_variables.port_sets["RuleVariableName"].definition #=> Array
resp.rule_group.rule_variables.port_sets["RuleVariableName"].definition[0] #=> String
resp.rule_group.reference_sets.ip_set_references #=> Hash
resp.rule_group.reference_sets.ip_set_references["IPSetReferenceName"].reference_arn #=> String
resp.rule_group.rules_source.rules_string #=> String
resp.rule_group.rules_source.rules_source_list.targets #=> Array
resp.rule_group.rules_source.rules_source_list.targets[0] #=> String
resp.rule_group.rules_source.rules_source_list.target_types #=> Array
resp.rule_group.rules_source.rules_source_list.target_types[0] #=> String, one of "TLS_SNI", "HTTP_HOST"
resp.rule_group.rules_source.rules_source_list.generated_rules_type #=> String, one of "ALLOWLIST", "DENYLIST"
resp.rule_group.rules_source.stateful_rules #=> Array
resp.rule_group.rules_source.stateful_rules[0].action #=> String, one of "PASS", "DROP", "ALERT", "REJECT"
resp.rule_group.rules_source.stateful_rules[0].header.protocol #=> String, one of "IP", "TCP", "UDP", "ICMP", "HTTP", "FTP", "TLS", "SMB", "DNS", "DCERPC", "SSH", "SMTP", "IMAP", "MSN", "KRB5", "IKEV2", "TFTP", "NTP", "DHCP"
resp.rule_group.rules_source.stateful_rules[0].header.source #=> String
resp.rule_group.rules_source.stateful_rules[0].header.source_port #=> String
resp.rule_group.rules_source.stateful_rules[0].header.direction #=> String, one of "FORWARD", "ANY"
resp.rule_group.rules_source.stateful_rules[0].header.destination #=> String
resp.rule_group.rules_source.stateful_rules[0].header.destination_port #=> String
resp.rule_group.rules_source.stateful_rules[0].rule_options #=> Array
resp.rule_group.rules_source.stateful_rules[0].rule_options[0].keyword #=> String
resp.rule_group.rules_source.stateful_rules[0].rule_options[0].settings #=> Array
resp.rule_group.rules_source.stateful_rules[0].rule_options[0].settings[0] #=> String
resp.rule_group.rules_source.stateless_rules_and_custom_actions.stateless_rules #=> Array
resp.rule_group.rules_source.stateless_rules_and_custom_actions.stateless_rules[0].rule_definition.match_attributes.sources #=> Array
resp.rule_group.rules_source.stateless_rules_and_custom_actions.stateless_rules[0].rule_definition.match_attributes.sources[0].address_definition #=> String
resp.rule_group.rules_source.stateless_rules_and_custom_actions.stateless_rules[0].rule_definition.match_attributes.destinations #=> Array
resp.rule_group.rules_source.stateless_rules_and_custom_actions.stateless_rules[0].rule_definition.match_attributes.destinations[0].address_definition #=> String
resp.rule_group.rules_source.stateless_rules_and_custom_actions.stateless_rules[0].rule_definition.match_attributes.source_ports #=> Array
resp.rule_group.rules_source.stateless_rules_and_custom_actions.stateless_rules[0].rule_definition.match_attributes.source_ports[0].from_port #=> Integer
resp.rule_group.rules_source.stateless_rules_and_custom_actions.stateless_rules[0].rule_definition.match_attributes.source_ports[0].to_port #=> Integer
resp.rule_group.rules_source.stateless_rules_and_custom_actions.stateless_rules[0].rule_definition.match_attributes.destination_ports #=> Array
resp.rule_group.rules_source.stateless_rules_and_custom_actions.stateless_rules[0].rule_definition.match_attributes.destination_ports[0].from_port #=> Integer
resp.rule_group.rules_source.stateless_rules_and_custom_actions.stateless_rules[0].rule_definition.match_attributes.destination_ports[0].to_port #=> Integer
resp.rule_group.rules_source.stateless_rules_and_custom_actions.stateless_rules[0].rule_definition.match_attributes.protocols #=> Array
resp.rule_group.rules_source.stateless_rules_and_custom_actions.stateless_rules[0].rule_definition.match_attributes.protocols[0] #=> Integer
resp.rule_group.rules_source.stateless_rules_and_custom_actions.stateless_rules[0].rule_definition.match_attributes.tcp_flags #=> Array
resp.rule_group.rules_source.stateless_rules_and_custom_actions.stateless_rules[0].rule_definition.match_attributes.tcp_flags[0].flags #=> Array
resp.rule_group.rules_source.stateless_rules_and_custom_actions.stateless_rules[0].rule_definition.match_attributes.tcp_flags[0].flags[0] #=> String, one of "FIN", "SYN", "RST", "PSH", "ACK", "URG", "ECE", "CWR"
resp.rule_group.rules_source.stateless_rules_and_custom_actions.stateless_rules[0].rule_definition.match_attributes.tcp_flags[0].masks #=> Array
resp.rule_group.rules_source.stateless_rules_and_custom_actions.stateless_rules[0].rule_definition.match_attributes.tcp_flags[0].masks[0] #=> String, one of "FIN", "SYN", "RST", "PSH", "ACK", "URG", "ECE", "CWR"
resp.rule_group.rules_source.stateless_rules_and_custom_actions.stateless_rules[0].rule_definition.actions #=> Array
resp.rule_group.rules_source.stateless_rules_and_custom_actions.stateless_rules[0].rule_definition.actions[0] #=> String
resp.rule_group.rules_source.stateless_rules_and_custom_actions.stateless_rules[0].priority #=> Integer
resp.rule_group.rules_source.stateless_rules_and_custom_actions.custom_actions #=> Array
resp.rule_group.rules_source.stateless_rules_and_custom_actions.custom_actions[0].action_name #=> String
resp.rule_group.rules_source.stateless_rules_and_custom_actions.custom_actions[0].action_definition.publish_metric_action.dimensions #=> Array
resp.rule_group.rules_source.stateless_rules_and_custom_actions.custom_actions[0].action_definition.publish_metric_action.dimensions[0].value #=> String
resp.rule_group.stateful_rule_options.rule_order #=> String, one of "DEFAULT_ACTION_ORDER", "STRICT_ORDER"
resp.rule_group_response.rule_group_arn #=> String
resp.rule_group_response.rule_group_name #=> String
resp.rule_group_response.rule_group_id #=> String
resp.rule_group_response.description #=> String
resp.rule_group_response.type #=> String, one of "STATELESS", "STATEFUL"
resp.rule_group_response.capacity #=> Integer
resp.rule_group_response.rule_group_status #=> String, one of "ACTIVE", "DELETING", "ERROR"
resp.rule_group_response.tags #=> Array
resp.rule_group_response.tags[0].key #=> String
resp.rule_group_response.tags[0].value #=> String
resp.rule_group_response.consumed_capacity #=> Integer
resp.rule_group_response.number_of_associations #=> Integer
resp.rule_group_response.encryption_configuration.key_id #=> String
resp.rule_group_response.encryption_configuration.type #=> String, one of "CUSTOMER_KMS", "AWS_OWNED_KMS_KEY"
resp.rule_group_response.source_metadata.source_arn #=> String
resp.rule_group_response.source_metadata.source_update_token #=> String
resp.rule_group_response.sns_topic #=> String
resp.rule_group_response.last_modified_time #=> Time
resp.rule_group_response.analysis_results #=> Array
resp.rule_group_response.analysis_results[0].identified_rule_ids #=> Array
resp.rule_group_response.analysis_results[0].identified_rule_ids[0] #=> String
resp.rule_group_response.analysis_results[0].identified_type #=> String, one of "STATELESS_RULE_FORWARDING_ASYMMETRICALLY", "STATELESS_RULE_CONTAINS_TCP_FLAGS"
resp.rule_group_response.analysis_results[0].analysis_detail #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :rule_group_name (String) —

    The descriptive name of the rule group. You can't change the name of a rule group after you create it.

    You must specify the ARN or the name, and you can specify both.

  • :rule_group_arn (String) —

    The Amazon Resource Name (ARN) of the rule group.

    You must specify the ARN or the name, and you can specify both.

  • :type (String) —

    Indicates whether the rule group is stateless or stateful. If the rule group is stateless, it contains stateless rules. If it is stateful, it contains stateful rules.

    This setting is required for requests that do not include the RuleGroupARN.

  • :analyze_rule_group (Boolean) —

    Indicates whether you want Network Firewall to analyze the stateless rules in the rule group for rule behavior such as asymmetric routing. If set to TRUE, Network Firewall runs the analysis.

Returns:

See Also:



2104
2105
2106
2107
 
# File 'gems/aws-sdk-networkfirewall/lib/aws-sdk-networkfirewall/client.rb', line 2104

def describe_rule_group(params = {}, options = {})
  req = build_request(:describe_rule_group, params)
  req.send_request(options)
end

#describe_rule_group_metadata(params = {}) ⇒ Types::DescribeRuleGroupMetadataResponse

High-level information about a rule group, returned by operations like create and describe. You can use the information provided in the metadata to retrieve and manage a rule group. You can retrieve all objects for a rule group by calling DescribeRuleGroup.

Examples:

Request syntax with placeholder values


resp = client.describe_rule_group_metadata({
  rule_group_name: "ResourceName",
  rule_group_arn: "ResourceArn",
  type: "STATELESS", # accepts STATELESS, STATEFUL
})

Response structure


resp.rule_group_arn #=> String
resp.rule_group_name #=> String
resp.description #=> String
resp.type #=> String, one of "STATELESS", "STATEFUL"
resp.capacity #=> Integer
resp.stateful_rule_options.rule_order #=> String, one of "DEFAULT_ACTION_ORDER", "STRICT_ORDER"
resp.last_modified_time #=> Time

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :rule_group_name (String) —

    The descriptive name of the rule group. You can't change the name of a rule group after you create it.

    You must specify the ARN or the name, and you can specify both.

  • :rule_group_arn (String) —

    The descriptive name of the rule group. You can't change the name of a rule group after you create it.

    You must specify the ARN or the name, and you can specify both.

  • :type (String) —

    Indicates whether the rule group is stateless or stateful. If the rule group is stateless, it contains stateless rules. If it is stateful, it contains stateful rules.

    This setting is required for requests that do not include the RuleGroupARN.

Returns:

See Also:



2168
2169
2170
2171
 
# File 'gems/aws-sdk-networkfirewall/lib/aws-sdk-networkfirewall/client.rb', line 2168

def describe_rule_group_metadata(params = {}, options = {})
  req = build_request(:describe_rule_group_metadata, params)
  req.send_request(options)
end

#describe_tls_inspection_configuration(params = {}) ⇒ Types::DescribeTLSInspectionConfigurationResponse

Returns the data objects for the specified TLS inspection configuration.

Examples:

Request syntax with placeholder values


resp = client.describe_tls_inspection_configuration({
  tls_inspection_configuration_arn: "ResourceArn",
  tls_inspection_configuration_name: "ResourceName",
})

Response structure


resp.update_token #=> String
resp.tls_inspection_configuration.server_certificate_configurations #=> Array
resp.tls_inspection_configuration.server_certificate_configurations[0].server_certificates #=> Array
resp.tls_inspection_configuration.server_certificate_configurations[0].server_certificates[0].resource_arn #=> String
resp.tls_inspection_configuration.server_certificate_configurations[0].scopes #=> Array
resp.tls_inspection_configuration.server_certificate_configurations[0].scopes[0].sources #=> Array
resp.tls_inspection_configuration.server_certificate_configurations[0].scopes[0].sources[0].address_definition #=> String
resp.tls_inspection_configuration.server_certificate_configurations[0].scopes[0].destinations #=> Array
resp.tls_inspection_configuration.server_certificate_configurations[0].scopes[0].destinations[0].address_definition #=> String
resp.tls_inspection_configuration.server_certificate_configurations[0].scopes[0].source_ports #=> Array
resp.tls_inspection_configuration.server_certificate_configurations[0].scopes[0].source_ports[0].from_port #=> Integer
resp.tls_inspection_configuration.server_certificate_configurations[0].scopes[0].source_ports[0].to_port #=> Integer
resp.tls_inspection_configuration.server_certificate_configurations[0].scopes[0].destination_ports #=> Array
resp.tls_inspection_configuration.server_certificate_configurations[0].scopes[0].destination_ports[0].from_port #=> Integer
resp.tls_inspection_configuration.server_certificate_configurations[0].scopes[0].destination_ports[0].to_port #=> Integer
resp.tls_inspection_configuration.server_certificate_configurations[0].scopes[0].protocols #=> Array
resp.tls_inspection_configuration.server_certificate_configurations[0].scopes[0].protocols[0] #=> Integer
resp.tls_inspection_configuration.server_certificate_configurations[0].certificate_authority_arn #=> String
resp.tls_inspection_configuration.server_certificate_configurations[0].check_certificate_revocation_status.revoked_status_action #=> String, one of "PASS", "DROP", "REJECT"
resp.tls_inspection_configuration.server_certificate_configurations[0].check_certificate_revocation_status.unknown_status_action #=> String, one of "PASS", "DROP", "REJECT"
resp.tls_inspection_configuration_response.tls_inspection_configuration_arn #=> String
resp.tls_inspection_configuration_response.tls_inspection_configuration_name #=> String
resp.tls_inspection_configuration_response.tls_inspection_configuration_id #=> String
resp.tls_inspection_configuration_response.tls_inspection_configuration_status #=> String, one of "ACTIVE", "DELETING", "ERROR"
resp.tls_inspection_configuration_response.description #=> String
resp.tls_inspection_configuration_response.tags #=> Array
resp.tls_inspection_configuration_response.tags[0].key #=> String
resp.tls_inspection_configuration_response.tags[0].value #=> String
resp.tls_inspection_configuration_response.last_modified_time #=> Time
resp.tls_inspection_configuration_response.number_of_associations #=> Integer
resp.tls_inspection_configuration_response.encryption_configuration.key_id #=> String
resp.tls_inspection_configuration_response.encryption_configuration.type #=> String, one of "CUSTOMER_KMS", "AWS_OWNED_KMS_KEY"
resp.tls_inspection_configuration_response.certificates #=> Array
resp.tls_inspection_configuration_response.certificates[0].certificate_arn #=> String
resp.tls_inspection_configuration_response.certificates[0].certificate_serial #=> String
resp.tls_inspection_configuration_response.certificates[0].status #=> String
resp.tls_inspection_configuration_response.certificates[0].status_message #=> String
resp.tls_inspection_configuration_response.certificate_authority.certificate_arn #=> String
resp.tls_inspection_configuration_response.certificate_authority.certificate_serial #=> String
resp.tls_inspection_configuration_response.certificate_authority.status #=> String
resp.tls_inspection_configuration_response.certificate_authority.status_message #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :tls_inspection_configuration_arn (String) —

    The Amazon Resource Name (ARN) of the TLS inspection configuration.

    You must specify the ARN or the name, and you can specify both.

  • :tls_inspection_configuration_name (String) —

    The descriptive name of the TLS inspection configuration. You can't change the name of a TLS inspection configuration after you create it.

    You must specify the ARN or the name, and you can specify both.

Returns:

See Also:



2248
2249
2250
2251
 
# File 'gems/aws-sdk-networkfirewall/lib/aws-sdk-networkfirewall/client.rb', line 2248

def describe_tls_inspection_configuration(params = {}, options = {})
  req = build_request(:describe_tls_inspection_configuration, params)
  req.send_request(options)
end

#disassociate_subnets(params = {}) ⇒ Types::DisassociateSubnetsResponse

Removes the specified subnet associations from the firewall. This removes the firewall endpoints from the subnets and removes any network filtering protections that the endpoints were providing.

Examples:

Request syntax with placeholder values


resp = client.disassociate_subnets({
  update_token: "UpdateToken",
  firewall_arn: "ResourceArn",
  firewall_name: "ResourceName",
  subnet_ids: ["AzSubnet"], # required
})

Response structure


resp.firewall_arn #=> String
resp.firewall_name #=> String
resp.subnet_mappings #=> Array
resp.subnet_mappings[0].subnet_id #=> String
resp.subnet_mappings[0].ip_address_type #=> String, one of "DUALSTACK", "IPV4", "IPV6"
resp.update_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :update_token (String) —

    An optional token that you can use for optimistic locking. Network Firewall returns a token to your requests that access the firewall. The token marks the state of the firewall resource at the time of the request.

    To make an unconditional change to the firewall, omit the token in your update request. Without the token, Network Firewall performs your updates regardless of whether the firewall has changed since you last retrieved it.

    To make a conditional change to the firewall, provide the token in your update request. Network Firewall uses the token to ensure that the firewall hasn't changed since you last retrieved it. If it has changed, the operation fails with an InvalidTokenException. If this happens, retrieve the firewall again to get a current copy of it with a new token. Reapply your changes as needed, then try the operation again using the new token.

  • :firewall_arn (String) —

    The Amazon Resource Name (ARN) of the firewall.

    You must specify the ARN or the name, and you can specify both.

  • :firewall_name (String) —

    The descriptive name of the firewall. You can't change the name of a firewall after you create it.

    You must specify the ARN or the name, and you can specify both.

  • :subnet_ids (required, Array<String>) —

    The unique identifiers for the subnets that you want to disassociate.

Returns:

See Also:



2319
2320
2321
2322
 
# File 'gems/aws-sdk-networkfirewall/lib/aws-sdk-networkfirewall/client.rb', line 2319

def disassociate_subnets(params = {}, options = {})
  req = build_request(:disassociate_subnets, params)
  req.send_request(options)
end

#get_analysis_report_results(params = {}) ⇒ Types::GetAnalysisReportResultsResponse

The results of a COMPLETED analysis report generated with StartAnalysisReport.

For more information, see AnalysisTypeReportResult.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.get_analysis_report_results({
  firewall_name: "ResourceName",
  analysis_report_id: "AnalysisReportId", # required
  firewall_arn: "ResourceArn",
  next_token: "AnalysisReportNextToken",
  max_results: 1,
})

Response structure


resp.status #=> String
resp.start_time #=> Time
resp.end_time #=> Time
resp.report_time #=> Time
resp.analysis_type #=> String, one of "TLS_SNI", "HTTP_HOST"
resp.next_token #=> String
resp.analysis_report_results #=> Array
resp.analysis_report_results[0].protocol #=> String
resp.analysis_report_results[0].first_accessed #=> Time
resp.analysis_report_results[0].last_accessed #=> Time
resp.analysis_report_results[0].domain #=> String
resp.analysis_report_results[0].hits.count #=> Integer
resp.analysis_report_results[0].unique_sources.count #=> Integer

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :firewall_name (String) —

    The descriptive name of the firewall. You can't change the name of a firewall after you create it.

    You must specify the ARN or the name, and you can specify both.

  • :analysis_report_id (required, String) —

    The unique ID of the query that ran when you requested an analysis report.

  • :firewall_arn (String) —

    The Amazon Resource Name (ARN) of the firewall.

    You must specify the ARN or the name, and you can specify both.

  • :next_token (String) —

    When you request a list of objects with a MaxResults setting, if the number of objects that are still available for retrieval exceeds the maximum you requested, Network Firewall returns a NextToken value in the response. To retrieve the next batch of objects, use the token returned from the prior request in your next request.

  • :max_results (Integer) —

    The maximum number of objects that you want Network Firewall to return for this request. If more objects are available, in the response, Network Firewall provides a NextToken value that you can use in a subsequent call to get the next batch of objects.

Returns:

See Also:



2399
2400
2401
2402
 
# File 'gems/aws-sdk-networkfirewall/lib/aws-sdk-networkfirewall/client.rb', line 2399

def get_analysis_report_results(params = {}, options = {})
  req = build_request(:get_analysis_report_results, params)
  req.send_request(options)
end

#list_analysis_reports(params = {}) ⇒ Types::ListAnalysisReportsResponse

Returns a list of all traffic analysis reports generated within the last 30 days.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_analysis_reports({
  firewall_name: "ResourceName",
  firewall_arn: "ResourceArn",
  next_token: "PaginationToken",
  max_results: 1,
})

Response structure


resp.analysis_reports #=> Array
resp.analysis_reports[0].analysis_report_id #=> String
resp.analysis_reports[0].analysis_type #=> String, one of "TLS_SNI", "HTTP_HOST"
resp.analysis_reports[0].report_time #=> Time
resp.analysis_reports[0].status #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :firewall_name (String) —

    The descriptive name of the firewall. You can't change the name of a firewall after you create it.

    You must specify the ARN or the name, and you can specify both.

  • :firewall_arn (String) —

    The Amazon Resource Name (ARN) of the firewall.

    You must specify the ARN or the name, and you can specify both.

  • :next_token (String) —

    When you request a list of objects with a MaxResults setting, if the number of objects that are still available for retrieval exceeds the maximum you requested, Network Firewall returns a NextToken value in the response. To retrieve the next batch of objects, use the token returned from the prior request in your next request.

  • :max_results (Integer) —

    The maximum number of objects that you want Network Firewall to return for this request. If more objects are available, in the response, Network Firewall provides a NextToken value that you can use in a subsequent call to get the next batch of objects.

Returns:

See Also:



2460
2461
2462
2463
 
# File 'gems/aws-sdk-networkfirewall/lib/aws-sdk-networkfirewall/client.rb', line 2460

def list_analysis_reports(params = {}, options = {})
  req = build_request(:list_analysis_reports, params)
  req.send_request(options)
end

#list_firewall_policies(params = {}) ⇒ Types::ListFirewallPoliciesResponse

Retrieves the metadata for the firewall policies that you have defined. Depending on your setting for max results and the number of firewall policies, a single call might not return the full list.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_firewall_policies({
  next_token: "PaginationToken",
  max_results: 1,
})

Response structure


resp.next_token #=> String
resp.firewall_policies #=> Array
resp.firewall_policies[0].name #=> String
resp.firewall_policies[0].arn #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :next_token (String) —

    When you request a list of objects with a MaxResults setting, if the number of objects that are still available for retrieval exceeds the maximum you requested, Network Firewall returns a NextToken value in the response. To retrieve the next batch of objects, use the token returned from the prior request in your next request.

  • :max_results (Integer) —

    The maximum number of objects that you want Network Firewall to return for this request. If more objects are available, in the response, Network Firewall provides a NextToken value that you can use in a subsequent call to get the next batch of objects.

Returns:

See Also:



2507
2508
2509
2510
 
# File 'gems/aws-sdk-networkfirewall/lib/aws-sdk-networkfirewall/client.rb', line 2507

def list_firewall_policies(params = {}, options = {})
  req = build_request(:list_firewall_policies, params)
  req.send_request(options)
end

#list_firewalls(params = {}) ⇒ Types::ListFirewallsResponse

Retrieves the metadata for the firewalls that you have defined. If you provide VPC identifiers in your request, this returns only the firewalls for those VPCs.

Depending on your setting for max results and the number of firewalls, a single call might not return the full list.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_firewalls({
  next_token: "PaginationToken",
  vpc_ids: ["VpcId"],
  max_results: 1,
})

Response structure


resp.next_token #=> String
resp.firewalls #=> Array
resp.firewalls[0].firewall_name #=> String
resp.firewalls[0].firewall_arn #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :next_token (String) —

    When you request a list of objects with a MaxResults setting, if the number of objects that are still available for retrieval exceeds the maximum you requested, Network Firewall returns a NextToken value in the response. To retrieve the next batch of objects, use the token returned from the prior request in your next request.

  • :vpc_ids (Array<String>) —

    The unique identifiers of the VPCs that you want Network Firewall to retrieve the firewalls for. Leave this blank to retrieve all firewalls that you have defined.

  • :max_results (Integer) —

    The maximum number of objects that you want Network Firewall to return for this request. If more objects are available, in the response, Network Firewall provides a NextToken value that you can use in a subsequent call to get the next batch of objects.

Returns:

See Also:



2563
2564
2565
2566
 
# File 'gems/aws-sdk-networkfirewall/lib/aws-sdk-networkfirewall/client.rb', line 2563

def list_firewalls(params = {}, options = {})
  req = build_request(:list_firewalls, params)
  req.send_request(options)
end

#list_flow_operation_results(params = {}) ⇒ Types::ListFlowOperationResultsResponse

Returns the results of a specific flow operation.

Flow operations let you manage the flows tracked in the flow table, also known as the firewall table.

A flow is network traffic that is monitored by a firewall, either by stateful or stateless rules. For traffic to be considered part of a flow, it must share Destination, DestinationPort, Direction, Protocol, Source, and SourcePort.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_flow_operation_results({
  firewall_arn: "ResourceArn", # required
  flow_operation_id: "FlowOperationId", # required
  next_token: "PaginationToken",
  max_results: 1,
  availability_zone: "AvailabilityZone",
})

Response structure


resp.firewall_arn #=> String
resp.availability_zone #=> String
resp.flow_operation_id #=> String
resp.flow_operation_status #=> String, one of "COMPLETED", "IN_PROGRESS", "FAILED", "COMPLETED_WITH_ERRORS"
resp.status_message #=> String
resp.flow_request_timestamp #=> Time
resp.flows #=> Array
resp.flows[0].source_address.address_definition #=> String
resp.flows[0].destination_address.address_definition #=> String
resp.flows[0].source_port #=> String
resp.flows[0].destination_port #=> String
resp.flows[0].protocol #=> String
resp.flows[0].age #=> Integer
resp.flows[0].packet_count #=> Integer
resp.flows[0].byte_count #=> Integer
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :firewall_arn (required, String) —

    The Amazon Resource Name (ARN) of the firewall.

  • :flow_operation_id (required, String) —

    A unique identifier for the flow operation. This ID is returned in the responses to start and list commands. You provide to describe commands.

  • :next_token (String) —

    When you request a list of objects with a MaxResults setting, if the number of objects that are still available for retrieval exceeds the maximum you requested, Network Firewall returns a NextToken value in the response. To retrieve the next batch of objects, use the token returned from the prior request in your next request.

  • :max_results (Integer) —

    The maximum number of objects that you want Network Firewall to return for this request. If more objects are available, in the response, Network Firewall provides a NextToken value that you can use in a subsequent call to get the next batch of objects.

  • :availability_zone (String) —

    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.

Returns:

See Also:



2652
2653
2654
2655
 
# File 'gems/aws-sdk-networkfirewall/lib/aws-sdk-networkfirewall/client.rb', line 2652

def list_flow_operation_results(params = {}, options = {})
  req = build_request(:list_flow_operation_results, params)
  req.send_request(options)
end

#list_flow_operations(params = {}) ⇒ Types::ListFlowOperationsResponse

Returns a list of all flow operations ran in a specific firewall. You can optionally narrow the request scope by specifying the operation type or Availability Zone associated with a firewall's flow operations.

Flow operations let you manage the flows tracked in the flow table, also known as the firewall table.

A flow is network traffic that is monitored by a firewall, either by stateful or stateless rules. For traffic to be considered part of a flow, it must share Destination, DestinationPort, Direction, Protocol, Source, and SourcePort.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_flow_operations({
  firewall_arn: "ResourceArn", # required
  availability_zone: "AvailabilityZone",
  flow_operation_type: "FLOW_FLUSH", # accepts FLOW_FLUSH, FLOW_CAPTURE
  next_token: "PaginationToken",
  max_results: 1,
})

Response structure


resp.flow_operations #=> Array
resp.flow_operations[0].flow_operation_id #=> String
resp.flow_operations[0].flow_operation_type #=> String, one of "FLOW_FLUSH", "FLOW_CAPTURE"
resp.flow_operations[0].flow_request_timestamp #=> Time
resp.flow_operations[0].flow_operation_status #=> String, one of "COMPLETED", "IN_PROGRESS", "FAILED", "COMPLETED_WITH_ERRORS"
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :firewall_arn (required, String) —

    The Amazon Resource Name (ARN) of the firewall.

  • :availability_zone (String) —

    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.

  • :flow_operation_type (String) —

    An optional string that defines whether any or all operation types are returned.

  • :next_token (String) —

    When you request a list of objects with a MaxResults setting, if the number of objects that are still available for retrieval exceeds the maximum you requested, Network Firewall returns a NextToken value in the response. To retrieve the next batch of objects, use the token returned from the prior request in your next request.

  • :max_results (Integer) —

    The maximum number of objects that you want Network Firewall to return for this request. If more objects are available, in the response, Network Firewall provides a NextToken value that you can use in a subsequent call to get the next batch of objects.

Returns:

See Also:



2727
2728
2729
2730
 
# File 'gems/aws-sdk-networkfirewall/lib/aws-sdk-networkfirewall/client.rb', line 2727

def list_flow_operations(params = {}, options = {})
  req = build_request(:list_flow_operations, params)
  req.send_request(options)
end

#list_rule_groups(params = {}) ⇒ Types::ListRuleGroupsResponse

Retrieves the metadata for the rule groups that you have defined. Depending on your setting for max results and the number of rule groups, a single call might not return the full list.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_rule_groups({
  next_token: "PaginationToken",
  max_results: 1,
  scope: "MANAGED", # accepts MANAGED, ACCOUNT
  managed_type: "AWS_MANAGED_THREAT_SIGNATURES", # accepts AWS_MANAGED_THREAT_SIGNATURES, AWS_MANAGED_DOMAIN_LISTS
  type: "STATELESS", # accepts STATELESS, STATEFUL
})

Response structure


resp.next_token #=> String
resp.rule_groups #=> Array
resp.rule_groups[0].name #=> String
resp.rule_groups[0].arn #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :next_token (String) —

    When you request a list of objects with a MaxResults setting, if the number of objects that are still available for retrieval exceeds the maximum you requested, Network Firewall returns a NextToken value in the response. To retrieve the next batch of objects, use the token returned from the prior request in your next request.

  • :max_results (Integer) —

    The maximum number of objects that you want Network Firewall to return for this request. If more objects are available, in the response, Network Firewall provides a NextToken value that you can use in a subsequent call to get the next batch of objects.

  • :scope (String) —

    The scope of the request. The default setting of ACCOUNT or a setting of NULL returns all of the rule groups in your account. A setting of MANAGED returns all available managed rule groups.

  • :managed_type (String) —

    Indicates the general category of the Amazon Web Services managed rule group.

  • :type (String) —

    Indicates whether the rule group is stateless or stateful. If the rule group is stateless, it contains stateless rules. If it is stateful, it contains stateful rules.

Returns:

See Also:



2791
2792
2793
2794
 
# File 'gems/aws-sdk-networkfirewall/lib/aws-sdk-networkfirewall/client.rb', line 2791

def list_rule_groups(params = {}, options = {})
  req = build_request(:list_rule_groups, params)
  req.send_request(options)
end

#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse

Retrieves the tags associated with the specified resource. Tags are key:value pairs that you can use to categorize and manage your resources, for purposes like billing. For example, you might set the tag key to "customer" and the value to the customer name or ID. You can specify one or more tags to add to each Amazon Web Services resource, up to 50 tags for a resource.

You can tag the Amazon Web Services resources that you manage through Network Firewall: firewalls, firewall policies, and rule groups.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_tags_for_resource({
  next_token: "PaginationToken",
  max_results: 1,
  resource_arn: "ResourceArn", # required
})

Response structure


resp.next_token #=> String
resp.tags #=> Array
resp.tags[0].key #=> String
resp.tags[0].value #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :next_token (String) —

    When you request a list of objects with a MaxResults setting, if the number of objects that are still available for retrieval exceeds the maximum you requested, Network Firewall returns a NextToken value in the response. To retrieve the next batch of objects, use the token returned from the prior request in your next request.

  • :max_results (Integer) —

    The maximum number of objects that you want Network Firewall to return for this request. If more objects are available, in the response, Network Firewall provides a NextToken value that you can use in a subsequent call to get the next batch of objects.

  • :resource_arn (required, String) —

    The Amazon Resource Name (ARN) of the resource.

Returns:

See Also:



2896
2897
2898
2899
 
# File 'gems/aws-sdk-networkfirewall/lib/aws-sdk-networkfirewall/client.rb', line 2896

def list_tags_for_resource(params = {}, options = {})
  req = build_request(:list_tags_for_resource, params)
  req.send_request(options)
end

#list_tls_inspection_configurations(params = {}) ⇒ Types::ListTLSInspectionConfigurationsResponse

Retrieves the metadata for the TLS inspection configurations that you have defined. Depending on your setting for max results and the number of TLS inspection configurations, a single call might not return the full list.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_tls_inspection_configurations({
  next_token: "PaginationToken",
  max_results: 1,
})

Response structure


resp.next_token #=> String
resp.tls_inspection_configurations #=> Array
resp.tls_inspection_configurations[0].name #=> String
resp.tls_inspection_configurations[0].arn #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :next_token (String) —

    When you request a list of objects with a MaxResults setting, if the number of objects that are still available for retrieval exceeds the maximum you requested, Network Firewall returns a NextToken value in the response. To retrieve the next batch of objects, use the token returned from the prior request in your next request.

  • :max_results (Integer) —

    The maximum number of objects that you want Network Firewall to return for this request. If more objects are available, in the response, Network Firewall provides a NextToken value that you can use in a subsequent call to get the next batch of objects.

Returns:

See Also:



2839
2840
2841
2842
 
# File 'gems/aws-sdk-networkfirewall/lib/aws-sdk-networkfirewall/client.rb', line 2839

def list_tls_inspection_configurations(params = {}, options = {})
  req = build_request(:list_tls_inspection_configurations, params)
  req.send_request(options)
end

#put_resource_policy(params = {}) ⇒ Struct

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.

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.

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.

For additional information about resource sharing using RAM, see Resource Access Manager User Guide.

Examples:

Request syntax with placeholder values


resp = client.put_resource_policy({
  resource_arn: "ResourceArn", # required
  policy: "PolicyString", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

    The Amazon Resource Name (ARN) of the account that you want to share rule groups and firewall policies with.

  • :policy (required, String) —

    The IAM policy statement that lists the accounts that you want to share your rule group or firewall policy with and the operations that you want the accounts to be able to perform.

    For a rule group resource, you can specify the following operations in the Actions section of the statement:

    • network-firewall:CreateFirewallPolicy

    • network-firewall:UpdateFirewallPolicy

    • network-firewall:ListRuleGroups

    For a firewall policy resource, you can specify the following operations in the Actions section of the statement:

    • network-firewall:AssociateFirewallPolicy

    • network-firewall:ListFirewallPolicies

    In the Resource section of the statement, you specify the ARNs for the rule groups and firewall policies that you want to share with the account that you specified in Arn.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



2973
2974
2975
2976
 
# File 'gems/aws-sdk-networkfirewall/lib/aws-sdk-networkfirewall/client.rb', line 2973

def put_resource_policy(params = {}, options = {})
  req = build_request(:put_resource_policy, params)
  req.send_request(options)
end

#start_analysis_report(params = {}) ⇒ Types::StartAnalysisReportResponse

Generates a traffic analysis report for the timeframe and traffic type you specify.

For information on the contents of a traffic analysis report, see AnalysisReport.

Examples:

Request syntax with placeholder values


resp = client.start_analysis_report({
  firewall_name: "ResourceName",
  firewall_arn: "ResourceArn",
  analysis_type: "TLS_SNI", # required, accepts TLS_SNI, HTTP_HOST
})

Response structure


resp.analysis_report_id #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :firewall_name (String) —

    The descriptive name of the firewall. You can't change the name of a firewall after you create it.

    You must specify the ARN or the name, and you can specify both.

  • :firewall_arn (String) —

    The Amazon Resource Name (ARN) of the firewall.

    You must specify the ARN or the name, and you can specify both.

  • :analysis_type (required, String) —

    The type of traffic that will be used to generate a report.

Returns:

See Also:



3018
3019
3020
3021
 
# File 'gems/aws-sdk-networkfirewall/lib/aws-sdk-networkfirewall/client.rb', line 3018

def start_analysis_report(params = {}, options = {})
  req = build_request(:start_analysis_report, params)
  req.send_request(options)
end

#start_flow_capture(params = {}) ⇒ Types::StartFlowCaptureResponse

Begins capturing the flows in a firewall, according to the filters you define. Captures are similar, but not identical to snapshots. Capture operations provide visibility into flows that are not closed and are tracked by a firewall's flow table. Unlike snapshots, captures are a time-boxed view.

A flow is network traffic that is monitored by a firewall, either by stateful or stateless rules. For traffic to be considered part of a flow, it must share Destination, DestinationPort, Direction, Protocol, Source, and SourcePort.

To avoid encountering operation limits, you should avoid starting captures with broad filters, like wide IP ranges. Instead, we recommend you define more specific criteria with FlowFilters, like narrow IP ranges, ports, or protocols.

Examples:

Request syntax with placeholder values


resp = client.start_flow_capture({
  firewall_arn: "ResourceArn", # required
  availability_zone: "AvailabilityZone",
  minimum_flow_age_in_seconds: 1,
  flow_filters: [ # required
    {
      source_address: {
        address_definition: "AddressDefinition", # required
      },
      destination_address: {
        address_definition: "AddressDefinition", # required
      },
      source_port: "Port",
      destination_port: "Port",
      protocols: ["ProtocolString"],
    },
  ],
})

Response structure


resp.firewall_arn #=> String
resp.flow_operation_id #=> String
resp.flow_operation_status #=> String, one of "COMPLETED", "IN_PROGRESS", "FAILED", "COMPLETED_WITH_ERRORS"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :firewall_arn (required, String) —

    The Amazon Resource Name (ARN) of the firewall.

  • :availability_zone (String) —

    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.

  • :minimum_flow_age_in_seconds (Integer) —

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

    We recommend setting this value to at least 1 minute (60 seconds) to reduce chance of capturing flows that are not yet established.

  • :flow_filters (required, Array<Types::FlowFilter>) —

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

Returns:

See Also:



3102
3103
3104
3105
 
# File 'gems/aws-sdk-networkfirewall/lib/aws-sdk-networkfirewall/client.rb', line 3102

def start_flow_capture(params = {}, options = {})
  req = build_request(:start_flow_capture, params)
  req.send_request(options)
end

#start_flow_flush(params = {}) ⇒ Types::StartFlowFlushResponse

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.

Examples:

Request syntax with placeholder values


resp = client.start_flow_flush({
  firewall_arn: "ResourceArn", # required
  availability_zone: "AvailabilityZone",
  minimum_flow_age_in_seconds: 1,
  flow_filters: [ # required
    {
      source_address: {
        address_definition: "AddressDefinition", # required
      },
      destination_address: {
        address_definition: "AddressDefinition", # required
      },
      source_port: "Port",
      destination_port: "Port",
      protocols: ["ProtocolString"],
    },
  ],
})

Response structure


resp.firewall_arn #=> String
resp.flow_operation_id #=> String
resp.flow_operation_status #=> String, one of "COMPLETED", "IN_PROGRESS", "FAILED", "COMPLETED_WITH_ERRORS"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :firewall_arn (required, String) —

    The Amazon Resource Name (ARN) of the firewall.

  • :availability_zone (String) —

    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.

  • :minimum_flow_age_in_seconds (Integer) —

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

  • :flow_filters (required, Array<Types::FlowFilter>) —

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

Returns:

See Also:



3173
3174
3175
3176
 
# File 'gems/aws-sdk-networkfirewall/lib/aws-sdk-networkfirewall/client.rb', line 3173

def start_flow_flush(params = {}, options = {})
  req = build_request(:start_flow_flush, params)
  req.send_request(options)
end

#tag_resource(params = {}) ⇒ Struct

Adds the specified tags to the specified resource. Tags are key:value pairs that you can use to categorize and manage your resources, for purposes like billing. For example, you might set the tag key to "customer" and the value to the customer name or ID. You can specify one or more tags to add to each Amazon Web Services resource, up to 50 tags for a resource.

You can tag the Amazon Web Services resources that you manage through Network Firewall: firewalls, firewall policies, and rule groups.

Examples:

Request syntax with placeholder values


resp = client.tag_resource({
  resource_arn: "ResourceArn", # required
  tags: [ # required
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

    The Amazon Resource Name (ARN) of the resource.

  • :tags (required, Array<Types::Tag>)

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



3211
3212
3213
3214
 
# File 'gems/aws-sdk-networkfirewall/lib/aws-sdk-networkfirewall/client.rb', line 3211

def tag_resource(params = {}, options = {})
  req = build_request(:tag_resource, params)
  req.send_request(options)
end

#untag_resource(params = {}) ⇒ Struct

Removes the tags with the specified keys from the specified resource. Tags are key:value pairs that you can use to categorize and manage your resources, for purposes like billing. For example, you might set the tag key to "customer" and the value to the customer name or ID. You can specify one or more tags to add to each Amazon Web Services resource, up to 50 tags for a resource.

You can manage tags for the Amazon Web Services resources that you manage through Network Firewall: firewalls, firewall policies, and rule groups.

Examples:

Request syntax with placeholder values


resp = client.untag_resource({
  resource_arn: "ResourceArn", # required
  tag_keys: ["TagKey"], # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

    The Amazon Resource Name (ARN) of the resource.

  • :tag_keys (required, Array<String>)

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



3245
3246
3247
3248
 
# File 'gems/aws-sdk-networkfirewall/lib/aws-sdk-networkfirewall/client.rb', line 3245

def untag_resource(params = {}, options = {})
  req = build_request(:untag_resource, params)
  req.send_request(options)
end

#update_firewall_analysis_settings(params = {}) ⇒ Types::UpdateFirewallAnalysisSettingsResponse

Enables specific types of firewall analysis on a specific firewall you define.

Examples:

Request syntax with placeholder values


resp = client.update_firewall_analysis_settings({
  enabled_analysis_types: ["TLS_SNI"], # accepts TLS_SNI, HTTP_HOST
  firewall_arn: "ResourceArn",
  firewall_name: "ResourceName",
  update_token: "UpdateToken",
})

Response structure


resp.enabled_analysis_types #=> Array
resp.enabled_analysis_types[0] #=> String, one of "TLS_SNI", "HTTP_HOST"
resp.firewall_arn #=> String
resp.firewall_name #=> String
resp.update_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :enabled_analysis_types (Array<String>) —

    An optional setting indicating the specific traffic analysis types to enable on the firewall.

  • :firewall_arn (String) —

    The Amazon Resource Name (ARN) of the firewall.

    You must specify the ARN or the name, and you can specify both.

  • :firewall_name (String) —

    The descriptive name of the firewall. You can't change the name of a firewall after you create it.

    You must specify the ARN or the name, and you can specify both.

  • :update_token (String) —

    An optional token that you can use for optimistic locking. Network Firewall returns a token to your requests that access the firewall. The token marks the state of the firewall resource at the time of the request.

    To make an unconditional change to the firewall, omit the token in your update request. Without the token, Network Firewall performs your updates regardless of whether the firewall has changed since you last retrieved it.

    To make a conditional change to the firewall, provide the token in your update request. Network Firewall uses the token to ensure that the firewall hasn't changed since you last retrieved it. If it has changed, the operation fails with an InvalidTokenException. If this happens, retrieve the firewall again to get a current copy of it with a new token. Reapply your changes as needed, then try the operation again using the new token.

Returns:

See Also:



3315
3316
3317
3318
 
# File 'gems/aws-sdk-networkfirewall/lib/aws-sdk-networkfirewall/client.rb', line 3315

def update_firewall_analysis_settings(params = {}, options = {})
  req = build_request(:update_firewall_analysis_settings, params)
  req.send_request(options)
end

#update_firewall_delete_protection(params = {}) ⇒ Types::UpdateFirewallDeleteProtectionResponse

Modifies the flag, DeleteProtection, which indicates whether it is possible to delete the firewall. If the flag is set to TRUE, the firewall is protected against deletion. This setting helps protect against accidentally deleting a firewall that's in use.

Examples:

Request syntax with placeholder values


resp = client.update_firewall_delete_protection({
  update_token: "UpdateToken",
  firewall_arn: "ResourceArn",
  firewall_name: "ResourceName",
  delete_protection: false, # required
})

Response structure


resp.firewall_arn #=> String
resp.firewall_name #=> String
resp.delete_protection #=> Boolean
resp.update_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :update_token (String) —

    An optional token that you can use for optimistic locking. Network Firewall returns a token to your requests that access the firewall. The token marks the state of the firewall resource at the time of the request.

    To make an unconditional change to the firewall, omit the token in your update request. Without the token, Network Firewall performs your updates regardless of whether the firewall has changed since you last retrieved it.

    To make a conditional change to the firewall, provide the token in your update request. Network Firewall uses the token to ensure that the firewall hasn't changed since you last retrieved it. If it has changed, the operation fails with an InvalidTokenException. If this happens, retrieve the firewall again to get a current copy of it with a new token. Reapply your changes as needed, then try the operation again using the new token.

  • :firewall_arn (String) —

    The Amazon Resource Name (ARN) of the firewall.

    You must specify the ARN or the name, and you can specify both.

  • :firewall_name (String) —

    The descriptive name of the firewall. You can't change the name of a firewall after you create it.

    You must specify the ARN or the name, and you can specify both.

  • :delete_protection (required, Boolean) —

    A flag indicating whether it is possible to delete the firewall. A setting of TRUE indicates that the firewall is protected against deletion. Use this setting to protect against accidentally deleting a firewall that is in use. When you create a firewall, the operation initializes this flag to TRUE.

Returns:

See Also:



3389
3390
3391
3392
 
# File 'gems/aws-sdk-networkfirewall/lib/aws-sdk-networkfirewall/client.rb', line 3389

def update_firewall_delete_protection(params = {}, options = {})
  req = build_request(:update_firewall_delete_protection, params)
  req.send_request(options)
end

#update_firewall_description(params = {}) ⇒ Types::UpdateFirewallDescriptionResponse

Modifies the description for the specified firewall. Use the description to help you identify the firewall when you're working with it.

Examples:

Request syntax with placeholder values


resp = client.update_firewall_description({
  update_token: "UpdateToken",
  firewall_arn: "ResourceArn",
  firewall_name: "ResourceName",
  description: "Description",
})

Response structure


resp.firewall_arn #=> String
resp.firewall_name #=> String
resp.description #=> String
resp.update_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :update_token (String) —

    An optional token that you can use for optimistic locking. Network Firewall returns a token to your requests that access the firewall. The token marks the state of the firewall resource at the time of the request.

    To make an unconditional change to the firewall, omit the token in your update request. Without the token, Network Firewall performs your updates regardless of whether the firewall has changed since you last retrieved it.

    To make a conditional change to the firewall, provide the token in your update request. Network Firewall uses the token to ensure that the firewall hasn't changed since you last retrieved it. If it has changed, the operation fails with an InvalidTokenException. If this happens, retrieve the firewall again to get a current copy of it with a new token. Reapply your changes as needed, then try the operation again using the new token.

  • :firewall_arn (String) —

    The Amazon Resource Name (ARN) of the firewall.

    You must specify the ARN or the name, and you can specify both.

  • :firewall_name (String) —

    The descriptive name of the firewall. You can't change the name of a firewall after you create it.

    You must specify the ARN or the name, and you can specify both.

  • :description (String) —

    The new description for the firewall. If you omit this setting, Network Firewall removes the description for the firewall.

Returns:

See Also:



3459
3460
3461
3462
 
# File 'gems/aws-sdk-networkfirewall/lib/aws-sdk-networkfirewall/client.rb', line 3459

def update_firewall_description(params = {}, options = {})
  req = build_request(:update_firewall_description, params)
  req.send_request(options)
end

#update_firewall_encryption_configuration(params = {}) ⇒ Types::UpdateFirewallEncryptionConfigurationResponse

A complex type that contains settings for encryption of your firewall resources.

Examples:

Request syntax with placeholder values


resp = client.update_firewall_encryption_configuration({
  update_token: "UpdateToken",
  firewall_arn: "ResourceArn",
  firewall_name: "ResourceName",
  encryption_configuration: {
    key_id: "KeyId",
    type: "CUSTOMER_KMS", # required, accepts CUSTOMER_KMS, AWS_OWNED_KMS_KEY
  },
})

Response structure


resp.firewall_arn #=> String
resp.firewall_name #=> String
resp.update_token #=> String
resp.encryption_configuration.key_id #=> String
resp.encryption_configuration.type #=> String, one of "CUSTOMER_KMS", "AWS_OWNED_KMS_KEY"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :update_token (String) —

    An optional token that you can use for optimistic locking. Network Firewall returns a token to your requests that access the firewall. The token marks the state of the firewall resource at the time of the request.

    To make an unconditional change to the firewall, omit the token in your update request. Without the token, Network Firewall performs your updates regardless of whether the firewall has changed since you last retrieved it.

    To make a conditional change to the firewall, provide the token in your update request. Network Firewall uses the token to ensure that the firewall hasn't changed since you last retrieved it. If it has changed, the operation fails with an InvalidTokenException. If this happens, retrieve the firewall again to get a current copy of it with a new token. Reapply your changes as needed, then try the operation again using the new token.

  • :firewall_arn (String) —

    The Amazon Resource Name (ARN) of the firewall.

  • :firewall_name (String) —

    The descriptive name of the firewall. You can't change the name of a firewall after you create it.

  • :encryption_configuration (Types::EncryptionConfiguration) —

    A complex type that contains optional Amazon Web Services Key Management Service (KMS) encryption settings for your Network Firewall resources. Your data is encrypted by default with an Amazon Web Services owned key that Amazon Web Services owns and manages for you. You can use either the Amazon Web Services owned key, or provide your own customer managed key. To learn more about KMS encryption of your Network Firewall resources, see Encryption at rest with Amazon Web Services Key Managment Service in the Network Firewall Developer Guide.

Returns:

See Also:



3539
3540
3541
3542
 
# File 'gems/aws-sdk-networkfirewall/lib/aws-sdk-networkfirewall/client.rb', line 3539

def update_firewall_encryption_configuration(params = {}, options = {})
  req = build_request(:update_firewall_encryption_configuration, params)
  req.send_request(options)
end

#update_firewall_policy(params = {}) ⇒ Types::UpdateFirewallPolicyResponse

Updates the properties of the specified firewall policy.

Examples:

Request syntax with placeholder values


resp = client.update_firewall_policy({
  update_token: "UpdateToken", # required
  firewall_policy_arn: "ResourceArn",
  firewall_policy_name: "ResourceName",
  firewall_policy: { # required
    stateless_rule_group_references: [
      {
        resource_arn: "ResourceArn", # required
        priority: 1, # required
      },
    ],
    stateless_default_actions: ["CollectionMember_String"], # required
    stateless_fragment_default_actions: ["CollectionMember_String"], # required
    stateless_custom_actions: [
      {
        action_name: "ActionName", # required
        action_definition: { # required
          publish_metric_action: {
            dimensions: [ # required
              {
                value: "DimensionValue", # required
              },
            ],
          },
        },
      },
    ],
    stateful_rule_group_references: [
      {
        resource_arn: "ResourceArn", # required
        priority: 1,
        override: {
          action: "DROP_TO_ALERT", # accepts DROP_TO_ALERT
        },
      },
    ],
    stateful_default_actions: ["CollectionMember_String"],
    stateful_engine_options: {
      rule_order: "DEFAULT_ACTION_ORDER", # accepts DEFAULT_ACTION_ORDER, STRICT_ORDER
      stream_exception_policy: "DROP", # accepts DROP, CONTINUE, REJECT
      flow_timeouts: {
        tcp_idle_timeout_seconds: 1,
      },
    },
    tls_inspection_configuration_arn: "ResourceArn",
    policy_variables: {
      rule_variables: {
        "RuleVariableName" => {
          definition: ["VariableDefinition"], # required
        },
      },
    },
  },
  description: "Description",
  dry_run: false,
  encryption_configuration: {
    key_id: "KeyId",
    type: "CUSTOMER_KMS", # required, accepts CUSTOMER_KMS, AWS_OWNED_KMS_KEY
  },
})

Response structure


resp.update_token #=> String
resp.firewall_policy_response.firewall_policy_name #=> String
resp.firewall_policy_response.firewall_policy_arn #=> String
resp.firewall_policy_response.firewall_policy_id #=> String
resp.firewall_policy_response.description #=> String
resp.firewall_policy_response.firewall_policy_status #=> String, one of "ACTIVE", "DELETING", "ERROR"
resp.firewall_policy_response.tags #=> Array
resp.firewall_policy_response.tags[0].key #=> String
resp.firewall_policy_response.tags[0].value #=> String
resp.firewall_policy_response.consumed_stateless_rule_capacity #=> Integer
resp.firewall_policy_response.consumed_stateful_rule_capacity #=> Integer
resp.firewall_policy_response.number_of_associations #=> Integer
resp.firewall_policy_response.encryption_configuration.key_id #=> String
resp.firewall_policy_response.encryption_configuration.type #=> String, one of "CUSTOMER_KMS", "AWS_OWNED_KMS_KEY"
resp.firewall_policy_response.last_modified_time #=> Time

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :update_token (required, String) —

    A token used for optimistic locking. Network Firewall returns a token to your requests that access the firewall policy. The token marks the state of the policy resource at the time of the request.

    To make changes to the policy, you provide the token in your request. Network Firewall uses the token to ensure that the policy hasn't changed since you last retrieved it. If it has changed, the operation fails with an InvalidTokenException. If this happens, retrieve the firewall policy again to get a current copy of it with current token. Reapply your changes as needed, then try the operation again using the new token.

  • :firewall_policy_arn (String) —

    The Amazon Resource Name (ARN) of the firewall policy.

    You must specify the ARN or the name, and you can specify both.

  • :firewall_policy_name (String) —

    The descriptive name of the firewall policy. You can't change the name of a firewall policy after you create it.

    You must specify the ARN or the name, and you can specify both.

  • :firewall_policy (required, Types::FirewallPolicy) —

    The updated firewall policy to use for the firewall. You can't add or remove a TLSInspectionConfiguration after you create a firewall policy. However, you can replace an existing TLS inspection configuration with another TLSInspectionConfiguration.

  • :description (String) —

    A description of the firewall policy.

  • :dry_run (Boolean) —

    Indicates whether you want Network Firewall to just check the validity of the request, rather than run the request.

    If set to TRUE, Network Firewall checks whether the request can run successfully, but doesn't actually make the requested changes. The call returns the value that the request would return if you ran it with dry run set to FALSE, but doesn't make additions or changes to your resources. This option allows you to make sure that you have the required permissions to run the request and that your request parameters are valid.

    If set to FALSE, Network Firewall makes the requested changes to your resources.

  • :encryption_configuration (Types::EncryptionConfiguration) —

    A complex type that contains settings for encryption of your firewall policy resources.

Returns:

See Also:



3688
3689
3690
3691
 
# File 'gems/aws-sdk-networkfirewall/lib/aws-sdk-networkfirewall/client.rb', line 3688

def update_firewall_policy(params = {}, options = {})
  req = build_request(:update_firewall_policy, params)
  req.send_request(options)
end

#update_firewall_policy_change_protection(params = {}) ⇒ Types::UpdateFirewallPolicyChangeProtectionResponse

Modifies the flag, ChangeProtection, which indicates whether it is possible to change the firewall. If the flag is set to TRUE, the firewall is protected from changes. This setting helps protect against accidentally changing a firewall that's in use.

Examples:

Request syntax with placeholder values


resp = client.update_firewall_policy_change_protection({
  update_token: "UpdateToken",
  firewall_arn: "ResourceArn",
  firewall_name: "ResourceName",
  firewall_policy_change_protection: false, # required
})

Response structure


resp.update_token #=> String
resp.firewall_arn #=> String
resp.firewall_name #=> String
resp.firewall_policy_change_protection #=> Boolean

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :update_token (String) —

    An optional token that you can use for optimistic locking. Network Firewall returns a token to your requests that access the firewall. The token marks the state of the firewall resource at the time of the request.

    To make an unconditional change to the firewall, omit the token in your update request. Without the token, Network Firewall performs your updates regardless of whether the firewall has changed since you last retrieved it.

    To make a conditional change to the firewall, provide the token in your update request. Network Firewall uses the token to ensure that the firewall hasn't changed since you last retrieved it. If it has changed, the operation fails with an InvalidTokenException. If this happens, retrieve the firewall again to get a current copy of it with a new token. Reapply your changes as needed, then try the operation again using the new token.

  • :firewall_arn (String) —

    The Amazon Resource Name (ARN) of the firewall.

    You must specify the ARN or the name, and you can specify both.

  • :firewall_name (String) —

    The descriptive name of the firewall. You can't change the name of a firewall after you create it.

    You must specify the ARN or the name, and you can specify both.

  • :firewall_policy_change_protection (required, Boolean) —

    A setting indicating whether the firewall is protected against a change to the firewall policy association. Use this setting to protect against accidentally modifying the firewall policy for a firewall that is in use. When you create a firewall, the operation initializes this setting to TRUE.

Returns:

See Also:



3762
3763
3764
3765
 
# File 'gems/aws-sdk-networkfirewall/lib/aws-sdk-networkfirewall/client.rb', line 3762

def update_firewall_policy_change_protection(params = {}, options = {})
  req = build_request(:update_firewall_policy_change_protection, params)
  req.send_request(options)
end

#update_logging_configuration(params = {}) ⇒ Types::UpdateLoggingConfigurationResponse

Sets the logging configuration for the specified firewall.

To change the logging configuration, retrieve the LoggingConfiguration by calling DescribeLoggingConfiguration, then change it and provide the modified object to this update call. You must change the logging configuration one LogDestinationConfig at a time inside the retrieved LoggingConfiguration object.

You can perform only one of the following actions in any call to UpdateLoggingConfiguration:

  • Create a new log destination object by adding a single LogDestinationConfig array element to LogDestinationConfigs.

  • Delete a log destination object by removing a single LogDestinationConfig array element from LogDestinationConfigs.

  • Change the LogDestination setting in a single LogDestinationConfig array element.

You can't change the LogDestinationType or LogType in a LogDestinationConfig. To change these settings, delete the existing LogDestinationConfig object and create a new one, using two separate calls to this update operation.

Examples:

Request syntax with placeholder values


resp = client.update_logging_configuration({
  firewall_arn: "ResourceArn",
  firewall_name: "ResourceName",
  logging_configuration: {
    log_destination_configs: [ # required
      {
        log_type: "ALERT", # required, accepts ALERT, FLOW, TLS
        log_destination_type: "S3", # required, accepts S3, CloudWatchLogs, KinesisDataFirehose
        log_destination: { # required
          "HashMapKey" => "HashMapValue",
        },
      },
    ],
  },
})

Response structure


resp.firewall_arn #=> String
resp.firewall_name #=> String
resp.logging_configuration.log_destination_configs #=> Array
resp.logging_configuration.log_destination_configs[0].log_type #=> String, one of "ALERT", "FLOW", "TLS"
resp.logging_configuration.log_destination_configs[0].log_destination_type #=> String, one of "S3", "CloudWatchLogs", "KinesisDataFirehose"
resp.logging_configuration.log_destination_configs[0].log_destination #=> Hash
resp.logging_configuration.log_destination_configs[0].log_destination["HashMapKey"] #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :firewall_arn (String) —

    The Amazon Resource Name (ARN) of the firewall.

    You must specify the ARN or the name, and you can specify both.

  • :firewall_name (String) —

    The descriptive name of the firewall. You can't change the name of a firewall after you create it.

    You must specify the ARN or the name, and you can specify both.

  • :logging_configuration (Types::LoggingConfiguration) —

    Defines how Network Firewall performs logging for a firewall. If you omit this setting, Network Firewall disables logging for the firewall.

Returns:

See Also:



3845
3846
3847
3848
 
# File 'gems/aws-sdk-networkfirewall/lib/aws-sdk-networkfirewall/client.rb', line 3845

def update_logging_configuration(params = {}, options = {})
  req = build_request(:update_logging_configuration, params)
  req.send_request(options)
end

#update_rule_group(params = {}) ⇒ Types::UpdateRuleGroupResponse

Updates the rule settings for the specified rule group. You use a rule group by reference in one or more firewall policies. When you modify a rule group, you modify all firewall policies that use the rule group.

To update a rule group, first call DescribeRuleGroup to retrieve the current RuleGroup object, update the object as needed, and then provide the updated object to this call.

Examples:

Request syntax with placeholder values


resp = client.update_rule_group({
  update_token: "UpdateToken", # required
  rule_group_arn: "ResourceArn",
  rule_group_name: "ResourceName",
  rule_group: {
    rule_variables: {
      ip_sets: {
        "RuleVariableName" => {
          definition: ["VariableDefinition"], # required
        },
      },
      port_sets: {
        "RuleVariableName" => {
          definition: ["VariableDefinition"],
        },
      },
    },
    reference_sets: {
      ip_set_references: {
        "IPSetReferenceName" => {
          reference_arn: "ResourceArn",
        },
      },
    },
    rules_source: { # required
      rules_string: "RulesString",
      rules_source_list: {
        targets: ["CollectionMember_String"], # required
        target_types: ["TLS_SNI"], # required, accepts TLS_SNI, HTTP_HOST
        generated_rules_type: "ALLOWLIST", # required, accepts ALLOWLIST, DENYLIST
      },
      stateful_rules: [
        {
          action: "PASS", # required, accepts PASS, DROP, ALERT, REJECT
          header: { # required
            protocol: "IP", # required, accepts IP, TCP, UDP, ICMP, HTTP, FTP, TLS, SMB, DNS, DCERPC, SSH, SMTP, IMAP, MSN, KRB5, IKEV2, TFTP, NTP, DHCP
            source: "Source", # required
            source_port: "Port", # required
            direction: "FORWARD", # required, accepts FORWARD, ANY
            destination: "Destination", # required
            destination_port: "Port", # required
          },
          rule_options: [ # required
            {
              keyword: "Keyword", # required
              settings: ["Setting"],
            },
          ],
        },
      ],
      stateless_rules_and_custom_actions: {
        stateless_rules: [ # required
          {
            rule_definition: { # required
              match_attributes: { # required
                sources: [
                  {
                    address_definition: "AddressDefinition", # required
                  },
                ],
                destinations: [
                  {
                    address_definition: "AddressDefinition", # required
                  },
                ],
                source_ports: [
                  {
                    from_port: 1, # required
                    to_port: 1, # required
                  },
                ],
                destination_ports: [
                  {
                    from_port: 1, # required
                    to_port: 1, # required
                  },
                ],
                protocols: [1],
                tcp_flags: [
                  {
                    flags: ["FIN"], # required, accepts FIN, SYN, RST, PSH, ACK, URG, ECE, CWR
                    masks: ["FIN"], # accepts FIN, SYN, RST, PSH, ACK, URG, ECE, CWR
                  },
                ],
              },
              actions: ["CollectionMember_String"], # required
            },
            priority: 1, # required
          },
        ],
        custom_actions: [
          {
            action_name: "ActionName", # required
            action_definition: { # required
              publish_metric_action: {
                dimensions: [ # required
                  {
                    value: "DimensionValue", # required
                  },
                ],
              },
            },
          },
        ],
      },
    },
    stateful_rule_options: {
      rule_order: "DEFAULT_ACTION_ORDER", # accepts DEFAULT_ACTION_ORDER, STRICT_ORDER
    },
  },
  rules: "RulesString",
  type: "STATELESS", # accepts STATELESS, STATEFUL
  description: "Description",
  dry_run: false,
  encryption_configuration: {
    key_id: "KeyId",
    type: "CUSTOMER_KMS", # required, accepts CUSTOMER_KMS, AWS_OWNED_KMS_KEY
  },
  source_metadata: {
    source_arn: "ResourceArn",
    source_update_token: "UpdateToken",
  },
  analyze_rule_group: false,
})

Response structure


resp.update_token #=> String
resp.rule_group_response.rule_group_arn #=> String
resp.rule_group_response.rule_group_name #=> String
resp.rule_group_response.rule_group_id #=> String
resp.rule_group_response.description #=> String
resp.rule_group_response.type #=> String, one of "STATELESS", "STATEFUL"
resp.rule_group_response.capacity #=> Integer
resp.rule_group_response.rule_group_status #=> String, one of "ACTIVE", "DELETING", "ERROR"
resp.rule_group_response.tags #=> Array
resp.rule_group_response.tags[0].key #=> String
resp.rule_group_response.tags[0].value #=> String
resp.rule_group_response.consumed_capacity #=> Integer
resp.rule_group_response.number_of_associations #=> Integer
resp.rule_group_response.encryption_configuration.key_id #=> String
resp.rule_group_response.encryption_configuration.type #=> String, one of "CUSTOMER_KMS", "AWS_OWNED_KMS_KEY"
resp.rule_group_response.source_metadata.source_arn #=> String
resp.rule_group_response.source_metadata.source_update_token #=> String
resp.rule_group_response.sns_topic #=> String
resp.rule_group_response.last_modified_time #=> Time
resp.rule_group_response.analysis_results #=> Array
resp.rule_group_response.analysis_results[0].identified_rule_ids #=> Array
resp.rule_group_response.analysis_results[0].identified_rule_ids[0] #=> String
resp.rule_group_response.analysis_results[0].identified_type #=> String, one of "STATELESS_RULE_FORWARDING_ASYMMETRICALLY", "STATELESS_RULE_CONTAINS_TCP_FLAGS"
resp.rule_group_response.analysis_results[0].analysis_detail #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :update_token (required, String) —

    A token used for optimistic locking. Network Firewall returns a token to your requests that access the rule group. The token marks the state of the rule group resource at the time of the request.

    To make changes to the rule group, you provide the token in your request. Network Firewall uses the token to ensure that the rule group hasn't changed since you last retrieved it. If it has changed, the operation fails with an InvalidTokenException. If this happens, retrieve the rule group again to get a current copy of it with a current token. Reapply your changes as needed, then try the operation again using the new token.

  • :rule_group_arn (String) —

    The Amazon Resource Name (ARN) of the rule group.

    You must specify the ARN or the name, and you can specify both.

  • :rule_group_name (String) —

    The descriptive name of the rule group. You can't change the name of a rule group after you create it.

    You must specify the ARN or the name, and you can specify both.

  • :rule_group (Types::RuleGroup) —

    An object that defines the rule group rules.

    You must provide either this rule group setting or a Rules setting, but not both.

  • :rules (String) —

    A string containing stateful rule group rules specifications in Suricata flat format, with one rule per line. Use this to import your existing Suricata compatible rule groups.

    You must provide either this rules setting or a populated RuleGroup setting, but not both.

    You can provide your rule group specification in Suricata flat format through this setting when you create or update your rule group. The call response returns a RuleGroup object that Network Firewall has populated from your string.

  • :type (String) —

    Indicates whether the rule group is stateless or stateful. If the rule group is stateless, it contains stateless rules. If it is stateful, it contains stateful rules.

    This setting is required for requests that do not include the RuleGroupARN.

  • :description (String) —

    A description of the rule group.

  • :dry_run (Boolean) —

    Indicates whether you want Network Firewall to just check the validity of the request, rather than run the request.

    If set to TRUE, Network Firewall checks whether the request can run successfully, but doesn't actually make the requested changes. The call returns the value that the request would return if you ran it with dry run set to FALSE, but doesn't make additions or changes to your resources. This option allows you to make sure that you have the required permissions to run the request and that your request parameters are valid.

    If set to FALSE, Network Firewall makes the requested changes to your resources.

  • :encryption_configuration (Types::EncryptionConfiguration) —

    A complex type that contains settings for encryption of your rule group resources.

  • :source_metadata (Types::SourceMetadata) —

    A complex type that contains metadata about the rule group that your own rule group is copied from. You can use the metadata to keep track of updates made to the originating rule group.

  • :analyze_rule_group (Boolean) —

    Indicates whether you want Network Firewall to analyze the stateless rules in the rule group for rule behavior such as asymmetric routing. If set to TRUE, Network Firewall runs the analysis and then updates the rule group for you. To run the stateless rule group analyzer without updating the rule group, set DryRun to TRUE.

Returns:

See Also:



4112
4113
4114
4115
 
# File 'gems/aws-sdk-networkfirewall/lib/aws-sdk-networkfirewall/client.rb', line 4112

def update_rule_group(params = {}, options = {})
  req = build_request(:update_rule_group, params)
  req.send_request(options)
end

#update_subnet_change_protection(params = {}) ⇒ Types::UpdateSubnetChangeProtectionResponse

Returns a response object which responds to the following methods:

Examples:

Request syntax with placeholder values


resp = client.update_subnet_change_protection({
  update_token: "UpdateToken",
  firewall_arn: "ResourceArn",
  firewall_name: "ResourceName",
  subnet_change_protection: false, # required
})

Response structure


resp.update_token #=> String
resp.firewall_arn #=> String
resp.firewall_name #=> String
resp.subnet_change_protection #=> Boolean

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :update_token (String) —

    An optional token that you can use for optimistic locking. Network Firewall returns a token to your requests that access the firewall. The token marks the state of the firewall resource at the time of the request.

    To make an unconditional change to the firewall, omit the token in your update request. Without the token, Network Firewall performs your updates regardless of whether the firewall has changed since you last retrieved it.

    To make a conditional change to the firewall, provide the token in your update request. Network Firewall uses the token to ensure that the firewall hasn't changed since you last retrieved it. If it has changed, the operation fails with an InvalidTokenException. If this happens, retrieve the firewall again to get a current copy of it with a new token. Reapply your changes as needed, then try the operation again using the new token.

  • :firewall_arn (String) —

    The Amazon Resource Name (ARN) of the firewall.

    You must specify the ARN or the name, and you can specify both.

  • :firewall_name (String) —

    The descriptive name of the firewall. You can't change the name of a firewall after you create it.

    You must specify the ARN or the name, and you can specify both.

  • :subnet_change_protection (required, Boolean) —

    A setting indicating whether the firewall is protected against changes to the subnet associations. Use this setting to protect against accidentally modifying the subnet associations for a firewall that is in use. When you create a firewall, the operation initializes this setting to TRUE.

Returns:

See Also:



4181
4182
4183
4184
 
# File 'gems/aws-sdk-networkfirewall/lib/aws-sdk-networkfirewall/client.rb', line 4181

def update_subnet_change_protection(params = {}, options = {})
  req = build_request(:update_subnet_change_protection, params)
  req.send_request(options)
end

#update_tls_inspection_configuration(params = {}) ⇒ Types::UpdateTLSInspectionConfigurationResponse

Updates the TLS inspection configuration settings for the specified TLS inspection configuration. You use a TLS inspection configuration by referencing it in one or more firewall policies. When you modify a TLS inspection configuration, you modify all firewall policies that use the TLS inspection configuration.

To update a TLS inspection configuration, first call DescribeTLSInspectionConfiguration to retrieve the current TLSInspectionConfiguration object, update the object as needed, and then provide the updated object to this call.

Examples:

Request syntax with placeholder values


resp = client.update_tls_inspection_configuration({
  tls_inspection_configuration_arn: "ResourceArn",
  tls_inspection_configuration_name: "ResourceName",
  tls_inspection_configuration: { # required
    server_certificate_configurations: [
      {
        server_certificates: [
          {
            resource_arn: "ResourceArn",
          },
        ],
        scopes: [
          {
            sources: [
              {
                address_definition: "AddressDefinition", # required
              },
            ],
            destinations: [
              {
                address_definition: "AddressDefinition", # required
              },
            ],
            source_ports: [
              {
                from_port: 1, # required
                to_port: 1, # required
              },
            ],
            destination_ports: [
              {
                from_port: 1, # required
                to_port: 1, # required
              },
            ],
            protocols: [1],
          },
        ],
        certificate_authority_arn: "ResourceArn",
        check_certificate_revocation_status: {
          revoked_status_action: "PASS", # accepts PASS, DROP, REJECT
          unknown_status_action: "PASS", # accepts PASS, DROP, REJECT
        },
      },
    ],
  },
  description: "Description",
  encryption_configuration: {
    key_id: "KeyId",
    type: "CUSTOMER_KMS", # required, accepts CUSTOMER_KMS, AWS_OWNED_KMS_KEY
  },
  update_token: "UpdateToken", # required
})

Response structure


resp.update_token #=> String
resp.tls_inspection_configuration_response.tls_inspection_configuration_arn #=> String
resp.tls_inspection_configuration_response.tls_inspection_configuration_name #=> String
resp.tls_inspection_configuration_response.tls_inspection_configuration_id #=> String
resp.tls_inspection_configuration_response.tls_inspection_configuration_status #=> String, one of "ACTIVE", "DELETING", "ERROR"
resp.tls_inspection_configuration_response.description #=> String
resp.tls_inspection_configuration_response.tags #=> Array
resp.tls_inspection_configuration_response.tags[0].key #=> String
resp.tls_inspection_configuration_response.tags[0].value #=> String
resp.tls_inspection_configuration_response.last_modified_time #=> Time
resp.tls_inspection_configuration_response.number_of_associations #=> Integer
resp.tls_inspection_configuration_response.encryption_configuration.key_id #=> String
resp.tls_inspection_configuration_response.encryption_configuration.type #=> String, one of "CUSTOMER_KMS", "AWS_OWNED_KMS_KEY"
resp.tls_inspection_configuration_response.certificates #=> Array
resp.tls_inspection_configuration_response.certificates[0].certificate_arn #=> String
resp.tls_inspection_configuration_response.certificates[0].certificate_serial #=> String
resp.tls_inspection_configuration_response.certificates[0].status #=> String
resp.tls_inspection_configuration_response.certificates[0].status_message #=> String
resp.tls_inspection_configuration_response.certificate_authority.certificate_arn #=> String
resp.tls_inspection_configuration_response.certificate_authority.certificate_serial #=> String
resp.tls_inspection_configuration_response.certificate_authority.status #=> String
resp.tls_inspection_configuration_response.certificate_authority.status_message #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :tls_inspection_configuration_arn (String) —

    The Amazon Resource Name (ARN) of the TLS inspection configuration.

  • :tls_inspection_configuration_name (String) —

    The descriptive name of the TLS inspection configuration. You can't change the name of a TLS inspection configuration after you create it.

  • :tls_inspection_configuration (required, Types::TLSInspectionConfiguration) —

    The object that defines a TLS inspection configuration. This, along with TLSInspectionConfigurationResponse, define the TLS inspection configuration. You can retrieve all objects for a TLS inspection configuration by calling DescribeTLSInspectionConfiguration.

    Network Firewall uses a TLS inspection configuration to decrypt traffic. Network Firewall re-encrypts the traffic before sending it to its destination.

    To use a TLS inspection configuration, you add it to a new Network Firewall firewall policy, then you apply the firewall policy to a firewall. Network Firewall acts as a proxy service to decrypt and inspect the traffic traveling through your firewalls. You can reference a TLS inspection configuration from more than one firewall policy, and you can use a firewall policy in more than one firewall. For more information about using TLS inspection configurations, see Inspecting SSL/TLS traffic with TLS inspection configurations in the Network Firewall Developer Guide.

  • :description (String) —

    A description of the TLS inspection configuration.

  • :encryption_configuration (Types::EncryptionConfiguration) —

    A complex type that contains the Amazon Web Services KMS encryption configuration settings for your TLS inspection configuration.

  • :update_token (required, String) —

    A token used for optimistic locking. Network Firewall returns a token to your requests that access the TLS inspection configuration. The token marks the state of the TLS inspection configuration resource at the time of the request.

    To make changes to the TLS inspection configuration, you provide the token in your request. Network Firewall uses the token to ensure that the TLS inspection configuration hasn't changed since you last retrieved it. If it has changed, the operation fails with an InvalidTokenException. If this happens, retrieve the TLS inspection configuration again to get a current copy of it with a current token. Reapply your changes as needed, then try the operation again using the new token.

Returns:

See Also:



4340
4341
4342
4343
 
# File 'gems/aws-sdk-networkfirewall/lib/aws-sdk-networkfirewall/client.rb', line 4340

def update_tls_inspection_configuration(params = {}, options = {})
  req = build_request(:update_tls_inspection_configuration, params)
  req.send_request(options)
end