Class: Aws::NetworkFirewall::Client

Inherits:
Seahorse::Client::Base
  • Object
show all
Includes:
ClientStubs
Defined in:
lib/aws-sdk-networkfirewall/client.rb,
sig/client.rbs

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.

Defined Under Namespace

Modules: _AcceptNetworkFirewallTransitGatewayAttachmentResponseSuccess, _AssociateAvailabilityZonesResponseSuccess, _AssociateFirewallPolicyResponseSuccess, _AssociateSubnetsResponseSuccess, _AttachRuleGroupsToProxyConfigurationResponseSuccess, _CreateContainerAssociationResponseSuccess, _CreateFirewallPolicyResponseSuccess, _CreateFirewallResponseSuccess, _CreateProxyConfigurationResponseSuccess, _CreateProxyResponseSuccess, _CreateProxyRuleGroupResponseSuccess, _CreateProxyRulesResponseSuccess, _CreateRuleGroupResponseSuccess, _CreateTLSInspectionConfigurationResponseSuccess, _CreateVpcEndpointAssociationResponseSuccess, _DeleteContainerAssociationResponseSuccess, _DeleteFirewallPolicyResponseSuccess, _DeleteFirewallResponseSuccess, _DeleteNetworkFirewallTransitGatewayAttachmentResponseSuccess, _DeleteProxyConfigurationResponseSuccess, _DeleteProxyResponseSuccess, _DeleteProxyRuleGroupResponseSuccess, _DeleteProxyRulesResponseSuccess, _DeleteResourcePolicyResponseSuccess, _DeleteRuleGroupResponseSuccess, _DeleteTLSInspectionConfigurationResponseSuccess, _DeleteVpcEndpointAssociationResponseSuccess, _DescribeContainerAssociationResponseSuccess, _DescribeFirewallMetadataResponseSuccess, _DescribeFirewallPolicyResponseSuccess, _DescribeFirewallResponseSuccess, _DescribeFlowOperationResponseSuccess, _DescribeLoggingConfigurationResponseSuccess, _DescribeProxyConfigurationResponseSuccess, _DescribeProxyResponseSuccess, _DescribeProxyRuleGroupResponseSuccess, _DescribeProxyRuleResponseSuccess, _DescribeResourcePolicyResponseSuccess, _DescribeRuleGroupMetadataResponseSuccess, _DescribeRuleGroupResponseSuccess, _DescribeRuleGroupSummaryResponseSuccess, _DescribeTLSInspectionConfigurationResponseSuccess, _DescribeVpcEndpointAssociationResponseSuccess, _DetachRuleGroupsFromProxyConfigurationResponseSuccess, _DisassociateAvailabilityZonesResponseSuccess, _DisassociateSubnetsResponseSuccess, _GetAnalysisReportResultsResponseSuccess, _ListAnalysisReportsResponseSuccess, _ListContainerAssociationsResponseSuccess, _ListFirewallPoliciesResponseSuccess, _ListFirewallsResponseSuccess, _ListFlowOperationResultsResponseSuccess, _ListFlowOperationsResponseSuccess, _ListProxiesResponseSuccess, _ListProxyConfigurationsResponseSuccess, _ListProxyRuleGroupsResponseSuccess, _ListRuleGroupsResponseSuccess, _ListTLSInspectionConfigurationsResponseSuccess, _ListTagsForResourceResponseSuccess, _ListVpcEndpointAssociationsResponseSuccess, _PutResourcePolicyResponseSuccess, _RejectNetworkFirewallTransitGatewayAttachmentResponseSuccess, _StartAnalysisReportResponseSuccess, _StartFlowCaptureResponseSuccess, _StartFlowFlushResponseSuccess, _TagResourceResponseSuccess, _UntagResourceResponseSuccess, _UpdateAvailabilityZoneChangeProtectionResponseSuccess, _UpdateContainerAssociationResponseSuccess, _UpdateFirewallAnalysisSettingsResponseSuccess, _UpdateFirewallDeleteProtectionResponseSuccess, _UpdateFirewallDescriptionResponseSuccess, _UpdateFirewallEncryptionConfigurationResponseSuccess, _UpdateFirewallPolicyChangeProtectionResponseSuccess, _UpdateFirewallPolicyResponseSuccess, _UpdateLoggingConfigurationResponseSuccess, _UpdateProxyConfigurationResponseSuccess, _UpdateProxyResponseSuccess, _UpdateProxyRuleGroupPrioritiesResponseSuccess, _UpdateProxyRulePrioritiesResponseSuccess, _UpdateProxyRuleResponseSuccess, _UpdateRuleGroupResponseSuccess, _UpdateSubnetChangeProtectionResponseSuccess, _UpdateTLSInspectionConfigurationResponseSuccess

Constant Summary collapse

Params =

Returns:

  • (:proxy_rule) 

      
    

  




  
Class Attribute Summary collapse

  




  
    

      API Operations
      collapse
    


    
    
  
    

      Class Method Summary
      collapse
    


    
    
  
    

      Instance Method Summary
      collapse
    


    
    
  


  
  

  
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 used for authentication. This can be any class that includes and implements
Aws::CredentialProvider, or 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.
    
          
        
    • 
      
        
  • 
          :auth_scheme_preference
          (Array<String>)
          
            
          
          
            — 
    A list of preferred authentication schemes to use when making a request. Supported values are:
sigv4, sigv4a, httpBearerAuth, and noAuth. When set using ENV['AWS_AUTH_SCHEME_PREFERENCE'] or in
shared config as auth_scheme_preference, the value should be a comma-separated list.
    
          
        
    • 
      
        
  • 
          :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
            
          
          
            — 
    When true, the SDK will not prepend the modeled host prefix to the endpoint.
    
          
        
    • 
      
        
  • 
          :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 the 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 - A retry mode that includes all the functionality of
standard mode along with automatic client side throttling.
      

      • 

    
          
        
    • 
      
        
  • 
          :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)
          
            
          
          
            — 
    Your Bearer token used for authentication. This can be any class that includes and implements
Aws::TokenProvider, or 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.
    
          
        
    • 
      
    

  








  

    
      


478
479
480

    		
    
      
# File 'lib/aws-sdk-networkfirewall/client.rb', line 478

def initialize(*args)
  super
end

    		
  





  



  

    
Class Attribute Details

    
      
      
      

  

  
    .identifier  ⇒ Object  (readonly)
  

  

  


  

    

  This method is part of a private API.
  You should avoid using this method if possible, as it may be removed or be changed in the future.




  





  



  

    
      


7278
7279
7280

    		
    
      
# File 'lib/aws-sdk-networkfirewall/client.rb', line 7278

def identifier
  @identifier
end

    		
  





    
  



  

    
Class Method Details


    
      

  

  
    .errors_module  ⇒ Object 
  

  

  


  

    

  This method is part of a private API.
  You should avoid using this method if possible, as it may be removed or be changed in the future.




  





  



  

    
      


7281
7282
7283

    		
    
      
# File 'lib/aws-sdk-networkfirewall/client.rb', line 7281

def errors_module
  Errors
end

    		
  





    
      

  

  
    .new  ⇒ Object 
  

  

  


  

    
https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/NetworkFirewall/Client.html#initialize-instance_method


  





  



  

    
      


14

    		
    
      
# File 'sig/client.rbs', line 14

def self.new: (

    		
  





    
  


  

    
Instance Method Details


    
      

  

  
    #accept_network_firewall_transit_gateway_attachment(params = {})  ⇒ Types::AcceptNetworkFirewallTransitGatewayAttachmentResponse 
  

  

  


  

    
Accepts a transit gateway attachment request for Network Firewall.
When you accept the attachment request, Network Firewall creates the
necessary routing components to enable traffic flow between the
transit gateway and firewall endpoints.


You must accept a transit gateway attachment to complete the creation
of a transit gateway-attached firewall, unless auto-accept is enabled
on the transit gateway. After acceptance, use DescribeFirewall to
verify the firewall status.


To reject an attachment instead of accepting it, use
RejectNetworkFirewallTransitGatewayAttachment.


 It can take several minutes for the attachment acceptance to complete
and the firewall to become available.

 

  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.accept_network_firewall_transit_gateway_attachment({
  transit_gateway_attachment_id: "TransitGatewayAttachmentId", # required
})

    
      
        
Response structure

      
      

resp.transit_gateway_attachment_id #=> String
resp.transit_gateway_attachment_status #=> String, one of "CREATING", "DELETING", "DELETED", "FAILED", "ERROR", "READY", "PENDING_ACCEPTANCE", "REJECTING", "REJECTED"

    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :transit_gateway_attachment_id
          (required, String)
          
            
          
          
            — 
    Required. The unique identifier of the transit gateway attachment to
accept. This ID is returned in the response when creating a transit
gateway-attached firewall.
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


88

    		
    
      
# File 'sig/client.rbs', line 88

def accept_network_firewall_transit_gateway_attachment: (

    		
  





    
      

  

  
    #associate_availability_zones(params = {})  ⇒ Types::AssociateAvailabilityZonesResponse 
  

  

  


  

    
Associates the specified Availability Zones with a transit
gateway-attached firewall. For each Availability Zone, Network
Firewall creates a firewall endpoint to process traffic. You can
specify one or more Availability Zones where you want to deploy the
firewall.


After adding Availability Zones, you must update your transit gateway
route tables to direct traffic through the new firewall endpoints. Use
DescribeFirewall to monitor the status of the new endpoints.


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.associate_availability_zones({
  update_token: "UpdateToken",
  firewall_arn: "ResourceArn",
  firewall_name: "ResourceName",
  availability_zone_mappings: [ # required
    {
      availability_zone: "AvailabilityZoneMappingString", # required
    },
  ],
})

    
      
        
Response structure

      
      

resp.firewall_arn #=> String
resp.firewall_name #=> String
resp.availability_zone_mappings #=> Array
resp.availability_zone_mappings[0].availability_zone #=> 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.
    
          
        
    • 
      
        
  • 
          :availability_zone_mappings
          (required, Array<Types::AvailabilityZoneMapping>)
          
            
          
          
            — 
    Required. The Availability Zones where you want to create firewall
endpoints. You must specify at least one Availability Zone.
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


101

    		
    
      
# File 'sig/client.rbs', line 101

def associate_availability_zones: (

    		
  





    
      

  

  
    #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:

  



  

    
      


121

    		
    
      
# File 'sig/client.rbs', line 121

def associate_firewall_policy: (

    		
  





    
      

  

  
    #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:

  



  

    
      


137

    		
    
      
# File 'sig/client.rbs', line 137

def associate_subnets: (

    		
  





    
      

  

  
    #attach_rule_groups_to_proxy_configuration(params = {})  ⇒ Types::AttachRuleGroupsToProxyConfigurationResponse 
  

  

  


  

    
Attaches ProxyRuleGroup resources to a ProxyConfiguration


A Proxy Configuration defines the monitoring and protection behavior
for a Proxy. The details of the behavior are defined in the rule
groups that you add to your configuration.


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.attach_rule_groups_to_proxy_configuration({
  proxy_configuration_name: "ResourceName",
  proxy_configuration_arn: "ResourceArn",
  rule_groups: [ # required
    {
      proxy_rule_group_name: "ResourceName",
      insert_position: 1,
    },
  ],
  update_token: "UpdateToken", # required
})

    
      
        
Response structure

      
      

resp.proxy_configuration.proxy_configuration_name #=> String
resp.proxy_configuration.proxy_configuration_arn #=> String
resp.proxy_configuration.description #=> String
resp.proxy_configuration.create_time #=> Time
resp.proxy_configuration.delete_time #=> Time
resp.proxy_configuration.rule_groups #=> Array
resp.proxy_configuration.rule_groups[0].proxy_rule_group_name #=> String
resp.proxy_configuration.rule_groups[0].proxy_rule_group_arn #=> String
resp.proxy_configuration.rule_groups[0].type #=> String
resp.proxy_configuration.rule_groups[0].priority #=> Integer
resp.proxy_configuration.default_rule_phase_actions.pre_dns #=> String, one of "ALLOW", "DENY", "ALERT"
resp.proxy_configuration.default_rule_phase_actions.pre_request #=> String, one of "ALLOW", "DENY", "ALERT"
resp.proxy_configuration.default_rule_phase_actions.post_response #=> String, one of "ALLOW", "DENY", "ALERT"
resp.proxy_configuration.tags #=> Array
resp.proxy_configuration.tags[0].key #=> String
resp.proxy_configuration.tags[0].value #=> String
resp.update_token #=> String

    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :proxy_configuration_name
          (String)
          
            
          
          
            — 
    The descriptive name of the proxy configuration. You can't change the
name of a proxy configuration after you create it.
    

    You must specify the ARN or the name, and you can specify both.
    
          
        
    • 
      
        
  • 
          :proxy_configuration_arn
          (String)
          
            
          
          
            — 
    The Amazon Resource Name (ARN) of a proxy configuration.
    

    You must specify the ARN or the name, and you can specify both.
    
          
        
    • 
      
        
  • 
          :rule_groups
          (required, Array<Types::ProxyRuleGroupAttachment>)
          
            
          
          
            — 
    The proxy rule group(s) to attach to the proxy configuration
    
          
        
    • 
      
        
  • 
          :update_token
          (required, String)
          
            
          
          
            — 
    A token used for optimistic locking. Network Firewall returns a token
to your requests that access the proxy configuration. The token marks
the state of the proxy configuration resource at the time of the
request.
    

    To make changes to the proxy configuration, you provide the token in
your request. Network Firewall uses the token to ensure that the proxy
configuration hasn't changed since you last retrieved it. If it has
changed, the operation fails with an InvalidTokenException. If this
happens, retrieve the proxy 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:

  



  

    
      


156

    		
    
      
# File 'sig/client.rbs', line 156

def attach_rule_groups_to_proxy_configuration: (

    		
  





    
      

  

  
    #build_request(operation_name, params = {})  ⇒ Object 
  

  

  


  

    

  This method is part of a private API.
  You should avoid using this method if possible, as it may be removed or be changed in the future.




  





  
Parameters:


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






  

    
      


7251
7252
7253
7254
7255
7256
7257
7258
7259
7260
7261
7262
7263
7264
7265
7266
7267

    		
    
      
# File 'lib/aws-sdk-networkfirewall/client.rb', line 7251

def build_request(operation_name, params = {})
  handlers = @handlers.for(operation_name)
  tracer = config.telemetry_provider.tracer_provider.tracer(
    Aws::Telemetry.module_to_tracer_name('Aws::NetworkFirewall')
  )
  context = Seahorse::Client::RequestContext.new(
    operation_name: operation_name,
    operation: config.api.operation(operation_name),
    client: self,
    params: params,
    config: config,
    tracer: tracer
  )
  context[:gem_name] = 'aws-sdk-networkfirewall'
  context[:gem_version] = '1.94.0'
  Seahorse::Client::Request.new(handlers, context)
end

    		
  





    
      

  

  
    #create_container_association(params = {})  ⇒ Types::CreateContainerAssociationResponse 
  

  

  


  

    
Creates a container association for Network Firewall. A container
association links container clusters (ECS or EKS) to Network Firewall,
enabling dynamic IP resolution for firewall rules based on container
attributes.


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


To retrieve information about container associations, use
ListContainerAssociations and DescribeContainerAssociation.


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.create_container_association({
  container_association_name: "ResourceName", # required
  description: "Description",
  type: "ECS", # required, accepts ECS, EKS
  container_monitoring_configurations: [ # required
    {
      cluster_arn: "ResourceArn", # required
      attribute_filters: [
        {
          key: "ContainerAttributeKey", # required
          value: "ContainerAttributeValue", # required
        },
      ],
    },
  ],
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
})

    
      
        
Response structure

      
      

resp.container_association_name #=> String
resp.container_association_arn #=> String
resp.description #=> String
resp.type #=> String, one of "ECS", "EKS"
resp.container_monitoring_configurations #=> Array
resp.container_monitoring_configurations[0].cluster_arn #=> String
resp.container_monitoring_configurations[0].attribute_filters #=> Array
resp.container_monitoring_configurations[0].attribute_filters[0].key #=> String
resp.container_monitoring_configurations[0].attribute_filters[0].value #=> String
resp.status #=> String, one of "ACTIVE", "CREATING", "DELETING", "UPDATING"
resp.tags #=> Array
resp.tags[0].key #=> String
resp.tags[0].value #=> String
resp.update_token #=> String

    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :container_association_name
          (required, String)
          
            
          
          
            — 
    The descriptive name of the container association. You can't change
the name of a container association after you create it.
    
          
        
    • 
      
        
  • 
          :description
          (String)
          
            
          
          
            — 
    A description of the container association.
    
          
        
    • 
      
        
  • 
          :type
          (required, String)
          
            
          
          
            — 
    The type of container orchestration platform for the clusters in this
association. Valid values are ECS and EKS. You can't change the
type after creation.
    
          
        
    • 
      
        
  • 
          :container_monitoring_configurations
          (required, Array<Types::ContainerMonitoringConfiguration>)
          
            
          
          
            — 
    The list of container monitoring configurations that define which
clusters and container attributes to monitor.
    
          
        
    • 
      
        
  • 
          :tags
          (Array<Types::Tag>)
          
            
          
          
            — 
    The key:value pairs to associate with the resource.
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


181

    		
    
      
# File 'sig/client.rbs', line 181

def create_container_association: (

    		
  





    
      

  

  
    #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
  transit_gateway_id: "TransitGatewayId",
  availability_zone_mappings: [
    {
      availability_zone: "AvailabilityZoneMappingString", # required
    },
  ],
  availability_zone_change_protection: false,
})

    
      
        
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.number_of_associations #=> Integer
resp.firewall.enabled_analysis_types #=> Array
resp.firewall.enabled_analysis_types[0] #=> String, one of "TLS_SNI", "HTTP_HOST"
resp.firewall.transit_gateway_id #=> String
resp.firewall. #=> String
resp.firewall.availability_zone_mappings #=> Array
resp.firewall.availability_zone_mappings[0].availability_zone #=> String
resp.firewall.availability_zone_change_protection #=> Boolean
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", "NOT_SUBSCRIBED", "DEPRECATED"
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
resp.firewall_status.transit_gateway_attachment_sync_state.attachment_id #=> String
resp.firewall_status.transit_gateway_attachment_sync_state.transit_gateway_attachment_status #=> String, one of "CREATING", "DELETING", "DELETED", "FAILED", "ERROR", "READY", "PENDING_ACCEPTANCE", "REJECTING", "REJECTED"
resp.firewall_status.transit_gateway_attachment_sync_state.status_message #=> String

    
  


  

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.
    
          
        
    • 
      
        
  • 
          :transit_gateway_id
          (String)
          
            
          
          
            — 
    Required when creating a transit gateway-attached firewall. The unique
identifier of the transit gateway to attach to this firewall. You can
provide either a transit gateway from your account or one that has
been shared with you through Resource Access Manager.
    

    After creating the firewall, you cannot change the transit gateway
association. To use a different transit gateway, you must create a new
firewall.
    

    For information about creating firewalls, see CreateFirewall. For
specific guidance about transit gateway-attached firewalls, see
Considerations for transit gateway-attached firewalls in the
Network Firewall Developer Guide.
    
          
        
    • 
      
        
  • 
          :availability_zone_mappings
          (Array<Types::AvailabilityZoneMapping>)
          
            
          
          
            — 
    Required. The Availability Zones where you want to create firewall
endpoints for a transit gateway-attached firewall. You must specify at
least one Availability Zone. Consider enabling the firewall in every
Availability Zone where you have workloads to maintain Availability
Zone isolation.
    

    You can modify Availability Zones later using
AssociateAvailabilityZones or DisassociateAvailabilityZones, but this
may briefly disrupt traffic. The AvailabilityZoneChangeProtection
setting controls whether you can make these modifications.
    
          
        
    • 
      
        
  • 
          :availability_zone_change_protection
          (Boolean)
          
            
          
          
            — 
    Optional. A setting indicating whether the firewall is protected
against changes to its Availability Zone configuration. When set to
TRUE, you cannot add or remove Availability Zones without first
disabling this protection using
UpdateAvailabilityZoneChangeProtection.
    

    Default value: FALSE
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


211

    		
    
      
# File 'sig/client.rbs', line 211

def create_firewall: (

    		
  





    
      

  

  
    #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
        },
        deep_threat_inspection: false,
      },
    ],
    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
        },
      },
    },
    enable_tls_session_holding: false,
  },
  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.consumed_stateful_domain_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:

  



  

    
      


252

    		
    
      
# File 'sig/client.rbs', line 252

def create_firewall_policy: (

    		
  





    
      

  

  
    #create_proxy(params = {})  ⇒ Types::CreateProxyResponse 
  

  

  


  

    
Creates an Network Firewall Proxy


Attaches a Proxy configuration to a NAT Gateway.


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


To retrieve information about proxies, use ListProxies and
DescribeProxy.


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.create_proxy({
  proxy_name: "ResourceName", # required
  nat_gateway_id: "NatGatewayId", # required
  proxy_configuration_name: "ResourceName",
  proxy_configuration_arn: "ResourceArn",
  listener_properties: [
    {
      port: 1, # required
      type: "HTTP", # required, accepts HTTP, HTTPS
    },
  ],
  tls_intercept_properties: { # required
    pca_arn: "ResourceArn",
    tls_intercept_mode: "ENABLED", # accepts ENABLED, DISABLED
  },
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
})

    
      
        
Response structure

      
      

resp.proxy.create_time #=> Time
resp.proxy.delete_time #=> Time
resp.proxy.update_time #=> Time
resp.proxy.failure_code #=> String
resp.proxy.failure_message #=> String
resp.proxy.proxy_state #=> String, one of "ATTACHING", "ATTACHED", "DETACHING", "DETACHED", "ATTACH_FAILED", "DETACH_FAILED"
resp.proxy.proxy_modify_state #=> String, one of "MODIFYING", "COMPLETED", "FAILED"
resp.proxy.nat_gateway_id #=> String
resp.proxy.proxy_configuration_name #=> String
resp.proxy.proxy_configuration_arn #=> String
resp.proxy.proxy_name #=> String
resp.proxy.proxy_arn #=> String
resp.proxy.listener_properties #=> Array
resp.proxy.listener_properties[0].port #=> Integer
resp.proxy.listener_properties[0].type #=> String, one of "HTTP", "HTTPS"
resp.proxy.tls_intercept_properties.pca_arn #=> String
resp.proxy.tls_intercept_properties.tls_intercept_mode #=> String, one of "ENABLED", "DISABLED"
resp.proxy.tags #=> Array
resp.proxy.tags[0].key #=> String
resp.proxy.tags[0].value #=> String
resp.update_token #=> String

    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :proxy_name
          (required, String)
          
            
          
          
            — 
    The descriptive name of the proxy. You can't change the name of a
proxy after you create it.
    
          
        
    • 
      
        
  • 
          :nat_gateway_id
          (required, String)
          
            
          
          
            — 
    A unique identifier for the NAT gateway to use with proxy resources.
    
          
        
    • 
      
        
  • 
          :proxy_configuration_name
          (String)
          
            
          
          
            — 
    The descriptive name of the proxy configuration. You can't change the
name of a proxy configuration after you create it.
    

    You must specify the ARN or the name, and you can specify both.
    
          
        
    • 
      
        
  • 
          :proxy_configuration_arn
          (String)
          
            
          
          
            — 
    The Amazon Resource Name (ARN) of a proxy configuration.
    

    You must specify the ARN or the name, and you can specify both.
    
          
        
    • 
      
        
  • 
          :listener_properties
          (Array<Types::ListenerPropertyRequest>)
          
            
          
          
            — 
    Listener properties for HTTP and HTTPS traffic.
    
          
        
    • 
      
        
  • 
          :tls_intercept_properties
          (required, Types::TlsInterceptPropertiesRequest)
          
            
          
          
            — 
    TLS decryption on traffic to filter on attributes in the HTTP header.
    
          
        
    • 
      
        
  • 
          :tags
          (Array<Types::Tag>)
          
            
          
          
            — 
    The key:value pairs to associate with the resource.
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


276

    		
    
      
# File 'sig/client.rbs', line 276

def create_proxy: (

    		
  





    
      

  

  
    #create_proxy_configuration(params = {})  ⇒ Types::CreateProxyConfigurationResponse 
  

  

  


  

    
Creates an Network Firewall ProxyConfiguration


A Proxy Configuration defines the monitoring and protection behavior
for a Proxy. The details of the behavior are defined in the rule
groups that you add to your configuration.


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


To retrieve information about proxies, use ListProxyConfigurations and
DescribeProxyConfiguration.


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.create_proxy_configuration({
  proxy_configuration_name: "ResourceName", # required
  description: "Description",
  rule_group_names: ["ResourceName"],
  rule_group_arns: ["ResourceArn"],
  default_rule_phase_actions: { # required
    pre_dns: "ALLOW", # accepts ALLOW, DENY, ALERT
    pre_request: "ALLOW", # accepts ALLOW, DENY, ALERT
    post_response: "ALLOW", # accepts ALLOW, DENY, ALERT
  },
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
})

    
      
        
Response structure

      
      

resp.proxy_configuration.proxy_configuration_name #=> String
resp.proxy_configuration.proxy_configuration_arn #=> String
resp.proxy_configuration.description #=> String
resp.proxy_configuration.create_time #=> Time
resp.proxy_configuration.delete_time #=> Time
resp.proxy_configuration.rule_groups #=> Array
resp.proxy_configuration.rule_groups[0].proxy_rule_group_name #=> String
resp.proxy_configuration.rule_groups[0].proxy_rule_group_arn #=> String
resp.proxy_configuration.rule_groups[0].type #=> String
resp.proxy_configuration.rule_groups[0].priority #=> Integer
resp.proxy_configuration.default_rule_phase_actions.pre_dns #=> String, one of "ALLOW", "DENY", "ALERT"
resp.proxy_configuration.default_rule_phase_actions.pre_request #=> String, one of "ALLOW", "DENY", "ALERT"
resp.proxy_configuration.default_rule_phase_actions.post_response #=> String, one of "ALLOW", "DENY", "ALERT"
resp.proxy_configuration.tags #=> Array
resp.proxy_configuration.tags[0].key #=> String
resp.proxy_configuration.tags[0].value #=> String
resp.update_token #=> String

    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :proxy_configuration_name
          (required, String)
          
            
          
          
            — 
    The descriptive name of the proxy configuration. You can't change the
name of a proxy configuration after you create it.
    
          
        
    • 
      
        
  • 
          :description
          (String)
          
            
          
          
            — 
    A description of the proxy configuration.
    
          
        
    • 
      
        
  • 
          :rule_group_names
          (Array<String>)
          
            
          
          
            — 
    The proxy rule group name(s) to attach to the proxy configuration.
    

    You must specify the ARNs or the names, and you can specify both.
    
          
        
    • 
      
        
  • 
          :rule_group_arns
          (Array<String>)
          
            
          
          
            — 
    The proxy rule group arn(s) to attach to the proxy configuration.
    

    You must specify the ARNs or the names, and you can specify both.
    
          
        
    • 
      
        
  • 
          :default_rule_phase_actions
          (required, Types::ProxyConfigDefaultRulePhaseActionsRequest)
          
            
          
          
            — 
    Evaluation points in the traffic flow where rules are applied. There
are three phases in a traffic where the rule match is applied.
    
          
        
    • 
      
        
  • 
          :tags
          (Array<Types::Tag>)
          
            
          
          
            — 
    The key:value pairs to associate with the resource.
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


306

    		
    
      
# File 'sig/client.rbs', line 306

def create_proxy_configuration: (

    		
  





    
      

  

  
    #create_proxy_rule_group(params = {})  ⇒ Types::CreateProxyRuleGroupResponse 
  

  

  


  

    
Creates an Network Firewall ProxyRuleGroup


Collections of related proxy filtering rules. Rule groups help you
manage and reuse sets of rules across multiple proxy configurations.


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


To retrieve information about proxy rule groups, use
ListProxyRuleGroups and DescribeProxyRuleGroup.


To retrieve information about individual proxy rules, use
DescribeProxyRuleGroup and DescribeProxyRule.


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.create_proxy_rule_group({
  proxy_rule_group_name: "ResourceName", # required
  description: "Description",
  rules: {
    pre_dns: [
      {
        proxy_rule_name: "ResourceName",
        description: "Description",
        action: "ALLOW", # accepts ALLOW, DENY, ALERT
        conditions: [
          {
            condition_operator: "ConditionOperator",
            condition_key: "ConditionKey",
            condition_values: ["ProxyConditionValue"],
          },
        ],
      },
    ],
    pre_request: [
      {
        proxy_rule_name: "ResourceName",
        description: "Description",
        action: "ALLOW", # accepts ALLOW, DENY, ALERT
        conditions: [
          {
            condition_operator: "ConditionOperator",
            condition_key: "ConditionKey",
            condition_values: ["ProxyConditionValue"],
          },
        ],
      },
    ],
    post_response: [
      {
        proxy_rule_name: "ResourceName",
        description: "Description",
        action: "ALLOW", # accepts ALLOW, DENY, ALERT
        conditions: [
          {
            condition_operator: "ConditionOperator",
            condition_key: "ConditionKey",
            condition_values: ["ProxyConditionValue"],
          },
        ],
      },
    ],
  },
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
})

    
      
        
Response structure

      
      

resp.proxy_rule_group.proxy_rule_group_name #=> String
resp.proxy_rule_group.proxy_rule_group_arn #=> String
resp.proxy_rule_group.create_time #=> Time
resp.proxy_rule_group.delete_time #=> Time
resp.proxy_rule_group.rules.pre_dns #=> Array
resp.proxy_rule_group.rules.pre_dns[0].proxy_rule_name #=> String
resp.proxy_rule_group.rules.pre_dns[0].description #=> String
resp.proxy_rule_group.rules.pre_dns[0].action #=> String, one of "ALLOW", "DENY", "ALERT"
resp.proxy_rule_group.rules.pre_dns[0].conditions #=> Array
resp.proxy_rule_group.rules.pre_dns[0].conditions[0].condition_operator #=> String
resp.proxy_rule_group.rules.pre_dns[0].conditions[0].condition_key #=> String
resp.proxy_rule_group.rules.pre_dns[0].conditions[0].condition_values #=> Array
resp.proxy_rule_group.rules.pre_dns[0].conditions[0].condition_values[0] #=> String
resp.proxy_rule_group.rules.pre_request #=> Array
resp.proxy_rule_group.rules.pre_request[0].proxy_rule_name #=> String
resp.proxy_rule_group.rules.pre_request[0].description #=> String
resp.proxy_rule_group.rules.pre_request[0].action #=> String, one of "ALLOW", "DENY", "ALERT"
resp.proxy_rule_group.rules.pre_request[0].conditions #=> Array
resp.proxy_rule_group.rules.pre_request[0].conditions[0].condition_operator #=> String
resp.proxy_rule_group.rules.pre_request[0].conditions[0].condition_key #=> String
resp.proxy_rule_group.rules.pre_request[0].conditions[0].condition_values #=> Array
resp.proxy_rule_group.rules.pre_request[0].conditions[0].condition_values[0] #=> String
resp.proxy_rule_group.rules.post_response #=> Array
resp.proxy_rule_group.rules.post_response[0].proxy_rule_name #=> String
resp.proxy_rule_group.rules.post_response[0].description #=> String
resp.proxy_rule_group.rules.post_response[0].action #=> String, one of "ALLOW", "DENY", "ALERT"
resp.proxy_rule_group.rules.post_response[0].conditions #=> Array
resp.proxy_rule_group.rules.post_response[0].conditions[0].condition_operator #=> String
resp.proxy_rule_group.rules.post_response[0].conditions[0].condition_key #=> String
resp.proxy_rule_group.rules.post_response[0].conditions[0].condition_values #=> Array
resp.proxy_rule_group.rules.post_response[0].conditions[0].condition_values[0] #=> String
resp.proxy_rule_group.description #=> String
resp.proxy_rule_group.tags #=> Array
resp.proxy_rule_group.tags[0].key #=> String
resp.proxy_rule_group.tags[0].value #=> String
resp.update_token #=> String

    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :proxy_rule_group_name
          (required, String)
          
            
          
          
            — 
    The descriptive name of the proxy rule group. You can't change the
name of a proxy rule group after you create it.
    
          
        
    • 
      
        
  • 
          :description
          (String)
          
            
          
          
            — 
    A description of the proxy rule group.
    
          
        
    • 
      
        
  • 
          :rules
          (Types::ProxyRulesByRequestPhase)
          
            
          
          
            — 
    Individual rules that define match conditions and actions for
application-layer traffic. Rules specify what to inspect (domains,
headers, methods) and what action to take (allow, deny, alert).
    
          
        
    • 
      
        
  • 
          :tags
          (Array<Types::Tag>)
          
            
          
          
            — 
    The key:value pairs to associate with the resource.
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


331

    		
    
      
# File 'sig/client.rbs', line 331

def create_proxy_rule_group: (

    		
  





    
      

  

  
    #create_proxy_rules(params = {})  ⇒ Types::CreateProxyRulesResponse 
  

  

  


  

    
Creates Network Firewall ProxyRule resources.


Attaches new proxy rule(s) to an existing proxy rule group.


To retrieve information about individual proxy rules, use
DescribeProxyRuleGroup and DescribeProxyRule.


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.create_proxy_rules({
  proxy_rule_group_arn: "ResourceArn",
  proxy_rule_group_name: "ResourceName",
  rules: { # required
    pre_dns: [
      {
        proxy_rule_name: "ResourceName",
        description: "Description",
        action: "ALLOW", # accepts ALLOW, DENY, ALERT
        conditions: [
          {
            condition_operator: "ConditionOperator",
            condition_key: "ConditionKey",
            condition_values: ["ProxyConditionValue"],
          },
        ],
        insert_position: 1,
      },
    ],
    pre_request: [
      {
        proxy_rule_name: "ResourceName",
        description: "Description",
        action: "ALLOW", # accepts ALLOW, DENY, ALERT
        conditions: [
          {
            condition_operator: "ConditionOperator",
            condition_key: "ConditionKey",
            condition_values: ["ProxyConditionValue"],
          },
        ],
        insert_position: 1,
      },
    ],
    post_response: [
      {
        proxy_rule_name: "ResourceName",
        description: "Description",
        action: "ALLOW", # accepts ALLOW, DENY, ALERT
        conditions: [
          {
            condition_operator: "ConditionOperator",
            condition_key: "ConditionKey",
            condition_values: ["ProxyConditionValue"],
          },
        ],
        insert_position: 1,
      },
    ],
  },
})

    
      
        
Response structure

      
      

resp.proxy_rule_group.proxy_rule_group_name #=> String
resp.proxy_rule_group.proxy_rule_group_arn #=> String
resp.proxy_rule_group.create_time #=> Time
resp.proxy_rule_group.delete_time #=> Time
resp.proxy_rule_group.rules.pre_dns #=> Array
resp.proxy_rule_group.rules.pre_dns[0].proxy_rule_name #=> String
resp.proxy_rule_group.rules.pre_dns[0].description #=> String
resp.proxy_rule_group.rules.pre_dns[0].action #=> String, one of "ALLOW", "DENY", "ALERT"
resp.proxy_rule_group.rules.pre_dns[0].conditions #=> Array
resp.proxy_rule_group.rules.pre_dns[0].conditions[0].condition_operator #=> String
resp.proxy_rule_group.rules.pre_dns[0].conditions[0].condition_key #=> String
resp.proxy_rule_group.rules.pre_dns[0].conditions[0].condition_values #=> Array
resp.proxy_rule_group.rules.pre_dns[0].conditions[0].condition_values[0] #=> String
resp.proxy_rule_group.rules.pre_request #=> Array
resp.proxy_rule_group.rules.pre_request[0].proxy_rule_name #=> String
resp.proxy_rule_group.rules.pre_request[0].description #=> String
resp.proxy_rule_group.rules.pre_request[0].action #=> String, one of "ALLOW", "DENY", "ALERT"
resp.proxy_rule_group.rules.pre_request[0].conditions #=> Array
resp.proxy_rule_group.rules.pre_request[0].conditions[0].condition_operator #=> String
resp.proxy_rule_group.rules.pre_request[0].conditions[0].condition_key #=> String
resp.proxy_rule_group.rules.pre_request[0].conditions[0].condition_values #=> Array
resp.proxy_rule_group.rules.pre_request[0].conditions[0].condition_values[0] #=> String
resp.proxy_rule_group.rules.post_response #=> Array
resp.proxy_rule_group.rules.post_response[0].proxy_rule_name #=> String
resp.proxy_rule_group.rules.post_response[0].description #=> String
resp.proxy_rule_group.rules.post_response[0].action #=> String, one of "ALLOW", "DENY", "ALERT"
resp.proxy_rule_group.rules.post_response[0].conditions #=> Array
resp.proxy_rule_group.rules.post_response[0].conditions[0].condition_operator #=> String
resp.proxy_rule_group.rules.post_response[0].conditions[0].condition_key #=> String
resp.proxy_rule_group.rules.post_response[0].conditions[0].condition_values #=> Array
resp.proxy_rule_group.rules.post_response[0].conditions[0].condition_values[0] #=> String
resp.proxy_rule_group.description #=> String
resp.proxy_rule_group.tags #=> Array
resp.proxy_rule_group.tags[0].key #=> String
resp.proxy_rule_group.tags[0].value #=> String
resp.update_token #=> String

    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :proxy_rule_group_arn
          (String)
          
            
          
          
            — 
    The Amazon Resource Name (ARN) of a proxy rule group.
    

    You must specify the ARN or the name, and you can specify both.
    
          
        
    • 
      
        
  • 
          :proxy_rule_group_name
          (String)
          
            
          
          
            — 
    The descriptive name of the proxy rule group. You can't change the
name of a proxy rule group after you create it.
    

    You must specify the ARN or the name, and you can specify both.
    
          
        
    • 
      
        
  • 
          :rules
          (required, Types::CreateProxyRulesByRequestPhase)
          
            
          
          
            — 
    Individual rules that define match conditions and actions for
application-layer traffic. Rules specify what to inspect (domains,
headers, methods) and what action to take (allow, deny, alert).
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


360

    		
    
      
# File 'sig/client.rbs', line 360

def create_proxy_rules: (

    		
  





    
      

  

  
    #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, REJECTLIST, ALERTLIST
      },
      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, HTTP2, QUIC
            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, STATEFUL_DOMAIN
  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,
  summary_configuration: {
    rule_options: ["SID"], # accepts SID, MSG, METADATA
  },
})

    
      
        
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", "STATEFUL_DOMAIN"
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
resp.rule_group_response.summary_configuration.rule_options #=> Array
resp.rule_group_response.summary_configuration.rule_options[0] #=> String, one of "SID", "MSG", "METADATA"

    
  


  

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.
    
          
        
    • 
      
        
  • 
          :summary_configuration
          (Types::SummaryConfiguration)
          
            
          
          
            — 
    An object that contains a RuleOptions array of strings. You use
RuleOptions to determine which of the following RuleSummary values
are returned in response to DescribeRuleGroupSummary.
    

      

    • 

      Metadata - returns
      

      • 

    • 

      Msg
      

      • 

    • 

      SID
      

      • 

    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


383

    		
    
      
# File 'sig/client.rbs', line 383

def create_rule_group: (

    		
  





    
      

  

  
    #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:

  



  

    
      


418

    		
    
      
# File 'sig/client.rbs', line 418

def create_tls_inspection_configuration: (

    		
  





    
      

  

  
    #create_vpc_endpoint_association(params = {})  ⇒ Types::CreateVpcEndpointAssociationResponse 
  

  

  


  

    
Creates a firewall endpoint for an Network Firewall firewall. This
type of firewall endpoint is independent of the firewall endpoints
that you specify in the Firewall itself, and you define it in
addition to those endpoints after the firewall has been created. You
can define a VPC endpoint association using a different VPC than the
one you used in the firewall specifications.


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.create_vpc_endpoint_association({
  firewall_arn: "ResourceArn", # required
  vpc_id: "VpcId", # required
  subnet_mapping: { # required
    subnet_id: "CollectionMember_String", # required
    ip_address_type: "DUALSTACK", # accepts DUALSTACK, IPV4, IPV6
  },
  description: "Description",
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
})

    
      
        
Response structure

      
      

resp.vpc_endpoint_association.vpc_endpoint_association_id #=> String
resp.vpc_endpoint_association.vpc_endpoint_association_arn #=> String
resp.vpc_endpoint_association.firewall_arn #=> String
resp.vpc_endpoint_association.vpc_id #=> String
resp.vpc_endpoint_association.subnet_mapping.subnet_id #=> String
resp.vpc_endpoint_association.subnet_mapping.ip_address_type #=> String, one of "DUALSTACK", "IPV4", "IPV6"
resp.vpc_endpoint_association.description #=> String
resp.vpc_endpoint_association.tags #=> Array
resp.vpc_endpoint_association.tags[0].key #=> String
resp.vpc_endpoint_association.tags[0].value #=> String
resp.vpc_endpoint_association_status.status #=> String, one of "PROVISIONING", "DELETING", "READY"
resp.vpc_endpoint_association_status.association_sync_state #=> Hash
resp.vpc_endpoint_association_status.association_sync_state["AvailabilityZone"].attachment.subnet_id #=> String
resp.vpc_endpoint_association_status.association_sync_state["AvailabilityZone"].attachment.endpoint_id #=> String
resp.vpc_endpoint_association_status.association_sync_state["AvailabilityZone"].attachment.status #=> String, one of "CREATING", "DELETING", "FAILED", "ERROR", "SCALING", "READY"
resp.vpc_endpoint_association_status.association_sync_state["AvailabilityZone"].attachment.status_message #=> String

    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :firewall_arn
          (required, String)
          
            
          
          
            — 
    The Amazon Resource Name (ARN) of the firewall.
    
          
        
    • 
      
        
  • 
          :vpc_id
          (required, String)
          
            
          
          
            — 
    The unique identifier of the VPC where you want to create a firewall
endpoint.
    
          
        
    • 
      
        
  • 
          :subnet_mapping
          (required, Types::SubnetMapping)
          
            
          
          
            — 
    The ID for a subnet that's used in an association with a firewall.
This is used in CreateFirewall, AssociateSubnets, and
CreateVpcEndpointAssociation. Network Firewall creates an instance of
the associated firewall in each subnet that you specify, to filter
traffic in the subnet's Availability Zone.
    
          
        
    • 
      
        
  • 
          :description
          (String)
          
            
          
          
            — 
    A description of the VPC endpoint association.
    
          
        
    • 
      
        
  • 
          :tags
          (Array<Types::Tag>)
          
            
          
          
            — 
    The key:value pairs to associate with the resource.
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


441

    		
    
      
# File 'sig/client.rbs', line 441

def create_vpc_endpoint_association: (

    		
  





    
      

  

  
    #delete_container_association(params = {})  ⇒ Types::DeleteContainerAssociationResponse 
  

  

  


  

    
Deletes the specified container association. When you delete a
container association, Network Firewall stops monitoring the
associated container clusters and removes the resolved IP addresses
from firewall rules.


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.delete_container_association({
  container_association_name: "ResourceName",
  container_association_arn: "ResourceArn",
})

    
      
        
Response structure

      
      

resp.container_association_name #=> String
resp.container_association_arn #=> String
resp.status #=> String, one of "ACTIVE", "CREATING", "DELETING", "UPDATING"

    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :container_association_name
          (String)
          
            
          
          
            — 
    The descriptive name of the container association. You must specify
the ARN or the name, and you can specify both.
    
          
        
    • 
      
        
  • 
          :container_association_arn
          (String)
          
            
          
          
            — 
    The Amazon Resource Name (ARN) of the container association. You must
specify the ARN or the name, and you can specify both.
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


465

    		
    
      
# File 'sig/client.rbs', line 465

def delete_container_association: (

    		
  





    
      

  

  
    #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.number_of_associations #=> Integer
resp.firewall.enabled_analysis_types #=> Array
resp.firewall.enabled_analysis_types[0] #=> String, one of "TLS_SNI", "HTTP_HOST"
resp.firewall.transit_gateway_id #=> String
resp.firewall. #=> String
resp.firewall.availability_zone_mappings #=> Array
resp.firewall.availability_zone_mappings[0].availability_zone #=> String
resp.firewall.availability_zone_change_protection #=> Boolean
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", "NOT_SUBSCRIBED", "DEPRECATED"
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
resp.firewall_status.transit_gateway_attachment_sync_state.attachment_id #=> String
resp.firewall_status.transit_gateway_attachment_sync_state.transit_gateway_attachment_status #=> String, one of "CREATING", "DELETING", "DELETED", "FAILED", "ERROR", "READY", "PENDING_ACCEPTANCE", "REJECTING", "REJECTED"
resp.firewall_status.transit_gateway_attachment_sync_state.status_message #=> 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.
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


477

    		
    
      
# File 'sig/client.rbs', line 477

def delete_firewall: (

    		
  





    
      

  

  
    #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.consumed_stateful_domain_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:

  



  

    
      


488

    		
    
      
# File 'sig/client.rbs', line 488

def delete_firewall_policy: (

    		
  





    
      

  

  
    #delete_network_firewall_transit_gateway_attachment(params = {})  ⇒ Types::DeleteNetworkFirewallTransitGatewayAttachmentResponse 
  

  

  


  

    
Deletes a transit gateway attachment from a Network Firewall. Either
the firewall owner or the transit gateway owner can delete the
attachment.


After you delete a transit gateway attachment, traffic will no longer
flow through the firewall endpoints.


After you initiate the delete operation, use DescribeFirewall to
monitor the deletion status.


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.delete_network_firewall_transit_gateway_attachment({
  transit_gateway_attachment_id: "TransitGatewayAttachmentId", # required
})

    
      
        
Response structure

      
      

resp.transit_gateway_attachment_id #=> String
resp.transit_gateway_attachment_status #=> String, one of "CREATING", "DELETING", "DELETED", "FAILED", "ERROR", "READY", "PENDING_ACCEPTANCE", "REJECTING", "REJECTED"

    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :transit_gateway_attachment_id
          (required, String)
          
            
          
          
            — 
    Required. The unique identifier of the transit gateway attachment to
delete.
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


500

    		
    
      
# File 'sig/client.rbs', line 500

def delete_network_firewall_transit_gateway_attachment: (

    		
  





    
      

  

  
    #delete_proxy(params = {})  ⇒ Types::DeleteProxyResponse 
  

  

  


  

    
Deletes the specified Proxy.


Detaches a Proxy configuration from a NAT Gateway.


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.delete_proxy({
  nat_gateway_id: "NatGatewayId", # required
  proxy_name: "ResourceName",
  proxy_arn: "ResourceArn",
})

    
      
        
Response structure

      
      

resp.nat_gateway_id #=> String
resp.proxy_name #=> String
resp.proxy_arn #=> String

    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :nat_gateway_id
          (required, String)
          
            
          
          
            — 
    The NAT Gateway the proxy is attached to.
    
          
        
    • 
      
        
  • 
          :proxy_name
          (String)
          
            
          
          
            — 
    The descriptive name of the proxy. You can't change the name of a
proxy after you create it.
    

    You must specify the ARN or the name, and you can specify both.
    
          
        
    • 
      
        
  • 
          :proxy_arn
          (String)
          
            
          
          
            — 
    The Amazon Resource Name (ARN) of a proxy.
    

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

  
    
    


Returns:



  
See Also:

  



  

    
      


512

    		
    
      
# File 'sig/client.rbs', line 512

def delete_proxy: (

    		
  





    
      

  

  
    #delete_proxy_configuration(params = {})  ⇒ Types::DeleteProxyConfigurationResponse 
  

  

  


  

    
Deletes the specified ProxyConfiguration.


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.delete_proxy_configuration({
  proxy_configuration_name: "ResourceName",
  proxy_configuration_arn: "ResourceArn",
})

    
      
        
Response structure

      
      

resp.proxy_configuration_name #=> String
resp.proxy_configuration_arn #=> String

    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :proxy_configuration_name
          (String)
          
            
          
          
            — 
    The descriptive name of the proxy configuration. You can't change the
name of a proxy configuration after you create it.
    

    You must specify the ARN or the name, and you can specify both.
    
          
        
    • 
      
        
  • 
          :proxy_configuration_arn
          (String)
          
            
          
          
            — 
    The Amazon Resource Name (ARN) of a proxy configuration.
    

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

  
    
    


Returns:



  
See Also:

  



  

    
      


525

    		
    
      
# File 'sig/client.rbs', line 525

def delete_proxy_configuration: (

    		
  





    
      

  

  
    #delete_proxy_rule_group(params = {})  ⇒ Types::DeleteProxyRuleGroupResponse 
  

  

  


  

    
Deletes the specified ProxyRuleGroup.


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.delete_proxy_rule_group({
  proxy_rule_group_name: "ResourceName",
  proxy_rule_group_arn: "ResourceArn",
})

    
      
        
Response structure

      
      

resp.proxy_rule_group_name #=> String
resp.proxy_rule_group_arn #=> String

    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :proxy_rule_group_name
          (String)
          
            
          
          
            — 
    The descriptive name of the proxy rule group. You can't change the
name of a proxy rule group after you create it.
    

    You must specify the ARN or the name, and you can specify both.
    
          
        
    • 
      
        
  • 
          :proxy_rule_group_arn
          (String)
          
            
          
          
            — 
    The Amazon Resource Name (ARN) of a proxy rule group.
    

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

  
    
    


Returns:



  
See Also:

  



  

    
      


537

    		
    
      
# File 'sig/client.rbs', line 537

def delete_proxy_rule_group: (

    		
  





    
      

  

  
    #delete_proxy_rules(params = {})  ⇒ Types::DeleteProxyRulesResponse 
  

  

  


  

    
Deletes the specified ProxyRule(s). currently attached to a
ProxyRuleGroup


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.delete_proxy_rules({
  proxy_rule_group_arn: "ResourceArn",
  proxy_rule_group_name: "ResourceName",
  rules: ["ResourceName"], # required
})

    
      
        
Response structure

      
      

resp.proxy_rule_group.proxy_rule_group_name #=> String
resp.proxy_rule_group.proxy_rule_group_arn #=> String
resp.proxy_rule_group.create_time #=> Time
resp.proxy_rule_group.delete_time #=> Time
resp.proxy_rule_group.rules.pre_dns #=> Array
resp.proxy_rule_group.rules.pre_dns[0].proxy_rule_name #=> String
resp.proxy_rule_group.rules.pre_dns[0].description #=> String
resp.proxy_rule_group.rules.pre_dns[0].action #=> String, one of "ALLOW", "DENY", "ALERT"
resp.proxy_rule_group.rules.pre_dns[0].conditions #=> Array
resp.proxy_rule_group.rules.pre_dns[0].conditions[0].condition_operator #=> String
resp.proxy_rule_group.rules.pre_dns[0].conditions[0].condition_key #=> String
resp.proxy_rule_group.rules.pre_dns[0].conditions[0].condition_values #=> Array
resp.proxy_rule_group.rules.pre_dns[0].conditions[0].condition_values[0] #=> String
resp.proxy_rule_group.rules.pre_request #=> Array
resp.proxy_rule_group.rules.pre_request[0].proxy_rule_name #=> String
resp.proxy_rule_group.rules.pre_request[0].description #=> String
resp.proxy_rule_group.rules.pre_request[0].action #=> String, one of "ALLOW", "DENY", "ALERT"
resp.proxy_rule_group.rules.pre_request[0].conditions #=> Array
resp.proxy_rule_group.rules.pre_request[0].conditions[0].condition_operator #=> String
resp.proxy_rule_group.rules.pre_request[0].conditions[0].condition_key #=> String
resp.proxy_rule_group.rules.pre_request[0].conditions[0].condition_values #=> Array
resp.proxy_rule_group.rules.pre_request[0].conditions[0].condition_values[0] #=> String
resp.proxy_rule_group.rules.post_response #=> Array
resp.proxy_rule_group.rules.post_response[0].proxy_rule_name #=> String
resp.proxy_rule_group.rules.post_response[0].description #=> String
resp.proxy_rule_group.rules.post_response[0].action #=> String, one of "ALLOW", "DENY", "ALERT"
resp.proxy_rule_group.rules.post_response[0].conditions #=> Array
resp.proxy_rule_group.rules.post_response[0].conditions[0].condition_operator #=> String
resp.proxy_rule_group.rules.post_response[0].conditions[0].condition_key #=> String
resp.proxy_rule_group.rules.post_response[0].conditions[0].condition_values #=> Array
resp.proxy_rule_group.rules.post_response[0].conditions[0].condition_values[0] #=> String
resp.proxy_rule_group.description #=> String
resp.proxy_rule_group.tags #=> Array
resp.proxy_rule_group.tags[0].key #=> String
resp.proxy_rule_group.tags[0].value #=> String

    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :proxy_rule_group_arn
          (String)
          
            
          
          
            — 
    The Amazon Resource Name (ARN) of a proxy rule group.
    

    You must specify the ARN or the name, and you can specify both.
    
          
        
    • 
      
        
  • 
          :proxy_rule_group_name
          (String)
          
            
          
          
            — 
    The descriptive name of the proxy rule group. You can't change the
name of a proxy rule group after you create it.
    

    You must specify the ARN or the name, and you can specify both.
    
          
        
    • 
      
        
  • 
          :rules
          (required, Array<String>)
          
            
          
          
            — 
    The proxy rule(s) to remove from the existing proxy rule group.
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


548

    		
    
      
# File 'sig/client.rbs', line 548

def delete_proxy_rules: (

    		
  





    
      

  

  
    #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:

  



  

    
      


559

    		
    
      
# File 'sig/client.rbs', line 559

def delete_resource_policy: (

    		
  





    
      

  

  
    #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, STATEFUL_DOMAIN
})

    
      
        
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", "STATEFUL_DOMAIN"
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
resp.rule_group_response.summary_configuration.rule_options #=> Array
resp.rule_group_response.summary_configuration.rule_options[0] #=> String, one of "SID", "MSG", "METADATA"

    
  


  

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:

  



  

    
      


569

    		
    
      
# File 'sig/client.rbs', line 569

def delete_rule_group: (

    		
  





    
      

  

  
    #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:

  



  

    
      


581

    		
    
      
# File 'sig/client.rbs', line 581

def delete_tls_inspection_configuration: (

    		
  





    
      

  

  
    #delete_vpc_endpoint_association(params = {})  ⇒ Types::DeleteVpcEndpointAssociationResponse 
  

  

  


  

    
Deletes the specified VpcEndpointAssociation.


You can check whether an endpoint association is in use by reviewing
the route tables for the Availability Zones where you have the
endpoint subnet mapping. You can retrieve the subnet mapping by
calling DescribeVpcEndpointAssociation. You define and update the
route tables through Amazon VPC. As needed, update the route tables
for the Availability Zone to remove the firewall endpoint for the
association. When the route tables no longer use the firewall
endpoint, you can remove the endpoint association safely.


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.delete_vpc_endpoint_association({
  vpc_endpoint_association_arn: "ResourceArn", # required
})

    
      
        
Response structure

      
      

resp.vpc_endpoint_association.vpc_endpoint_association_id #=> String
resp.vpc_endpoint_association.vpc_endpoint_association_arn #=> String
resp.vpc_endpoint_association.firewall_arn #=> String
resp.vpc_endpoint_association.vpc_id #=> String
resp.vpc_endpoint_association.subnet_mapping.subnet_id #=> String
resp.vpc_endpoint_association.subnet_mapping.ip_address_type #=> String, one of "DUALSTACK", "IPV4", "IPV6"
resp.vpc_endpoint_association.description #=> String
resp.vpc_endpoint_association.tags #=> Array
resp.vpc_endpoint_association.tags[0].key #=> String
resp.vpc_endpoint_association.tags[0].value #=> String
resp.vpc_endpoint_association_status.status #=> String, one of "PROVISIONING", "DELETING", "READY"
resp.vpc_endpoint_association_status.association_sync_state #=> Hash
resp.vpc_endpoint_association_status.association_sync_state["AvailabilityZone"].attachment.subnet_id #=> String
resp.vpc_endpoint_association_status.association_sync_state["AvailabilityZone"].attachment.endpoint_id #=> String
resp.vpc_endpoint_association_status.association_sync_state["AvailabilityZone"].attachment.status #=> String, one of "CREATING", "DELETING", "FAILED", "ERROR", "SCALING", "READY"
resp.vpc_endpoint_association_status.association_sync_state["AvailabilityZone"].attachment.status_message #=> String

    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :vpc_endpoint_association_arn
          (required, String)
          
            
          
          
            — 
    The Amazon Resource Name (ARN) of a VPC endpoint association.
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


593

    		
    
      
# File 'sig/client.rbs', line 593

def delete_vpc_endpoint_association: (

    		
  





    
      

  

  
    #describe_container_association(params = {})  ⇒ Types::DescribeContainerAssociationResponse 
  

  

  


  

    
Returns the properties of a container association.


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.describe_container_association({
  container_association_name: "ResourceName",
  container_association_arn: "ResourceArn",
})

    
      
        
Response structure

      
      

resp.container_association_name #=> String
resp.container_association_arn #=> String
resp.description #=> String
resp.type #=> String, one of "ECS", "EKS"
resp.container_monitoring_configurations #=> Array
resp.container_monitoring_configurations[0].cluster_arn #=> String
resp.container_monitoring_configurations[0].attribute_filters #=> Array
resp.container_monitoring_configurations[0].attribute_filters[0].key #=> String
resp.container_monitoring_configurations[0].attribute_filters[0].value #=> String
resp.status #=> String, one of "ACTIVE", "CREATING", "DELETING", "UPDATING"
resp.resolved_cidr_count #=> Integer
resp.last_updated_time #=> Time
resp.tags #=> Array
resp.tags[0].key #=> String
resp.tags[0].value #=> String
resp.update_token #=> String

    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :container_association_name
          (String)
          
            
          
          
            — 
    The descriptive name of the container association. You must specify
the ARN or the name, and you can specify both.
    
          
        
    • 
      
        
  • 
          :container_association_arn
          (String)
          
            
          
          
            — 
    The Amazon Resource Name (ARN) of the container association. You must
specify the ARN or the name, and you can specify both.
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


612

    		
    
      
# File 'sig/client.rbs', line 612

def describe_container_association: (

    		
  





    
      

  

  
    #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.number_of_associations #=> Integer
resp.firewall.enabled_analysis_types #=> Array
resp.firewall.enabled_analysis_types[0] #=> String, one of "TLS_SNI", "HTTP_HOST"
resp.firewall.transit_gateway_id #=> String
resp.firewall. #=> String
resp.firewall.availability_zone_mappings #=> Array
resp.firewall.availability_zone_mappings[0].availability_zone #=> String
resp.firewall.availability_zone_change_protection #=> Boolean
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", "NOT_SUBSCRIBED", "DEPRECATED"
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
resp.firewall_status.transit_gateway_attachment_sync_state.attachment_id #=> String
resp.firewall_status.transit_gateway_attachment_sync_state.transit_gateway_attachment_status #=> String, one of "CREATING", "DELETING", "DELETED", "FAILED", "ERROR", "READY", "PENDING_ACCEPTANCE", "REJECTING", "REJECTED"
resp.firewall_status.transit_gateway_attachment_sync_state.status_message #=> 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.
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


625

    		
    
      
# File 'sig/client.rbs', line 625

def describe_firewall: (

    		
  





    
      

  

  
    #describe_firewall_metadata(params = {})  ⇒ Types::DescribeFirewallMetadataResponse 
  

  

  


  

    
Returns the high-level information about a firewall, including the
Availability Zones where the Firewall is currently in use.


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.describe_firewall_metadata({
  firewall_arn: "ResourceArn",
})

    
      
        
Response structure

      
      

resp.firewall_arn #=> String
resp.firewall_policy_arn #=> String
resp.description #=> String
resp.status #=> String, one of "PROVISIONING", "DELETING", "READY"
resp.supported_availability_zones #=> Hash
resp.supported_availability_zones["AvailabilityZone"].ip_address_type #=> String, one of "DUALSTACK", "IPV4", "IPV6"
resp.transit_gateway_attachment_id #=> String

    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :firewall_arn
          (String)
          
            
          
          
            — 
    The Amazon Resource Name (ARN) of the firewall.
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


641

    		
    
      
# File 'sig/client.rbs', line 641

def describe_firewall_metadata: (

    		
  





    
      

  

  
    #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.consumed_stateful_domain_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_rule_group_references[0].deep_threat_inspection #=> Boolean
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
resp.firewall_policy.enable_tls_session_holding #=> Boolean

    
  


  

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:

  



  

    
      


653

    		
    
      
# File 'sig/client.rbs', line 653

def describe_firewall_policy: (

    		
  





    
      

  

  
    #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",
  vpc_endpoint_association_arn: "ResourceArn",
  vpc_endpoint_id: "VpcEndpointId",
  flow_operation_id: "FlowOperationId", # required
})

    
      
        
Response structure

      
      

resp.firewall_arn #=> String
resp.availability_zone #=> String
resp.vpc_endpoint_association_arn #=> String
resp.vpc_endpoint_id #=> 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.
    
          
        
    • 
      
        
  • 
          :vpc_endpoint_association_arn
          (String)
          
            
          
          
            — 
    The Amazon Resource Name (ARN) of a VPC endpoint association.
    
          
        
    • 
      
        
  • 
          :vpc_endpoint_id
          (String)
          
            
          
          
            — 
    A unique identifier for the primary endpoint associated with a
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.
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


673

    		
    
      
# File 'sig/client.rbs', line 673

def describe_flow_operation: (

    		
  





    
      

  

  
    #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
resp.enable_monitoring_dashboard #=> Boolean

    
  


  

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:

  



  

    
      


689

    		
    
      
# File 'sig/client.rbs', line 689

def describe_logging_configuration: (

    		
  





    
      

  

  
    #describe_proxy(params = {})  ⇒ Types::DescribeProxyResponse 
  

  

  


  

    
Returns the data objects for the specified proxy.


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.describe_proxy({
  proxy_name: "ResourceName",
  proxy_arn: "ResourceArn",
})

    
      
        
Response structure

      
      

resp.proxy.proxy_name #=> String
resp.proxy.proxy_arn #=> String
resp.proxy.proxy_configuration_name #=> String
resp.proxy.proxy_configuration_arn #=> String
resp.proxy.nat_gateway_id #=> String
resp.proxy.proxy_state #=> String, one of "ATTACHING", "ATTACHED", "DETACHING", "DETACHED", "ATTACH_FAILED", "DETACH_FAILED"
resp.proxy.proxy_modify_state #=> String, one of "MODIFYING", "COMPLETED", "FAILED"
resp.proxy.listener_properties #=> Array
resp.proxy.listener_properties[0].port #=> Integer
resp.proxy.listener_properties[0].type #=> String, one of "HTTP", "HTTPS"
resp.proxy.tls_intercept_properties.pca_arn #=> String
resp.proxy.tls_intercept_properties.tls_intercept_mode #=> String, one of "ENABLED", "DISABLED"
resp.proxy.vpc_endpoint_service_name #=> String
resp.proxy.private_dns_name #=> String
resp.proxy.create_time #=> Time
resp.proxy.delete_time #=> Time
resp.proxy.update_time #=> Time
resp.proxy.failure_code #=> String
resp.proxy.failure_message #=> String
resp.proxy.tags #=> Array
resp.proxy.tags[0].key #=> String
resp.proxy.tags[0].value #=> String
resp.update_token #=> String

    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :proxy_name
          (String)
          
            
          
          
            — 
    The descriptive name of the proxy. You can't change the name of a
proxy after you create it.
    

    You must specify the ARN or the name, and you can specify both.
    
          
        
    • 
      
        
  • 
          :proxy_arn
          (String)
          
            
          
          
            — 
    The Amazon Resource Name (ARN) of a proxy.
    

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

  
    
    


Returns:



  
See Also:

  



  

    
      


701

    		
    
      
# File 'sig/client.rbs', line 701

def describe_proxy: (

    		
  





    
      

  

  
    #describe_proxy_configuration(params = {})  ⇒ Types::DescribeProxyConfigurationResponse 
  

  

  


  

    
Returns the data objects for the specified proxy configuration.


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.describe_proxy_configuration({
  proxy_configuration_name: "ResourceName",
  proxy_configuration_arn: "ResourceArn",
})

    
      
        
Response structure

      
      

resp.proxy_configuration.proxy_configuration_name #=> String
resp.proxy_configuration.proxy_configuration_arn #=> String
resp.proxy_configuration.description #=> String
resp.proxy_configuration.create_time #=> Time
resp.proxy_configuration.delete_time #=> Time
resp.proxy_configuration.rule_groups #=> Array
resp.proxy_configuration.rule_groups[0].proxy_rule_group_name #=> String
resp.proxy_configuration.rule_groups[0].proxy_rule_group_arn #=> String
resp.proxy_configuration.rule_groups[0].type #=> String
resp.proxy_configuration.rule_groups[0].priority #=> Integer
resp.proxy_configuration.default_rule_phase_actions.pre_dns #=> String, one of "ALLOW", "DENY", "ALERT"
resp.proxy_configuration.default_rule_phase_actions.pre_request #=> String, one of "ALLOW", "DENY", "ALERT"
resp.proxy_configuration.default_rule_phase_actions.post_response #=> String, one of "ALLOW", "DENY", "ALERT"
resp.proxy_configuration.tags #=> Array
resp.proxy_configuration.tags[0].key #=> String
resp.proxy_configuration.tags[0].value #=> String
resp.update_token #=> String

    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :proxy_configuration_name
          (String)
          
            
          
          
            — 
    The descriptive name of the proxy configuration. You can't change the
name of a proxy configuration after you create it.
    

    You must specify the ARN or the name, and you can specify both.
    
          
        
    • 
      
        
  • 
          :proxy_configuration_arn
          (String)
          
            
          
          
            — 
    The Amazon Resource Name (ARN) of a proxy configuration.
    

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

  
    
    


Returns:



  
See Also:

  



  

    
      


713

    		
    
      
# File 'sig/client.rbs', line 713

def describe_proxy_configuration: (

    		
  





    
      

  

  
    #describe_proxy_rule(params = {})  ⇒ Types::DescribeProxyRuleResponse 
  

  

  


  

    
Returns the data objects for the specified proxy configuration for the
specified proxy rule group.


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.describe_proxy_rule({
  proxy_rule_name: "ResourceName", # required
  proxy_rule_group_name: "ResourceName",
  proxy_rule_group_arn: "ResourceArn",
})

    
      
        
Response structure

      
      

resp.proxy_rule.proxy_rule_name #=> String
resp.proxy_rule.description #=> String
resp.proxy_rule.action #=> String, one of "ALLOW", "DENY", "ALERT"
resp.proxy_rule.conditions #=> Array
resp.proxy_rule.conditions[0].condition_operator #=> String
resp.proxy_rule.conditions[0].condition_key #=> String
resp.proxy_rule.conditions[0].condition_values #=> Array
resp.proxy_rule.conditions[0].condition_values[0] #=> String
resp.update_token #=> String

    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :proxy_rule_name
          (required, String)
          
            
          
          
            — 
    The descriptive name of the proxy rule. You can't change the name of
a proxy rule after you create it.
    
          
        
    • 
      
        
  • 
          :proxy_rule_group_name
          (String)
          
            
          
          
            — 
    The descriptive name of the proxy rule group. You can't change the
name of a proxy rule group after you create it.
    

    You must specify the ARN or the name, and you can specify both.
    
          
        
    • 
      
        
  • 
          :proxy_rule_group_arn
          (String)
          
            
          
          
            — 
    The Amazon Resource Name (ARN) of a proxy rule group.
    

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

  
    
    


Returns:



  
See Also:

  



  

    
      


725

    		
    
      
# File 'sig/client.rbs', line 725

def describe_proxy_rule: (

    		
  





    
      

  

  
    #describe_proxy_rule_group(params = {})  ⇒ Types::DescribeProxyRuleGroupResponse 
  

  

  


  

    
Returns the data objects for the specified proxy rule group.


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.describe_proxy_rule_group({
  proxy_rule_group_name: "ResourceName",
  proxy_rule_group_arn: "ResourceArn",
})

    
      
        
Response structure

      
      

resp.proxy_rule_group.proxy_rule_group_name #=> String
resp.proxy_rule_group.proxy_rule_group_arn #=> String
resp.proxy_rule_group.create_time #=> Time
resp.proxy_rule_group.delete_time #=> Time
resp.proxy_rule_group.rules.pre_dns #=> Array
resp.proxy_rule_group.rules.pre_dns[0].proxy_rule_name #=> String
resp.proxy_rule_group.rules.pre_dns[0].description #=> String
resp.proxy_rule_group.rules.pre_dns[0].action #=> String, one of "ALLOW", "DENY", "ALERT"
resp.proxy_rule_group.rules.pre_dns[0].conditions #=> Array
resp.proxy_rule_group.rules.pre_dns[0].conditions[0].condition_operator #=> String
resp.proxy_rule_group.rules.pre_dns[0].conditions[0].condition_key #=> String
resp.proxy_rule_group.rules.pre_dns[0].conditions[0].condition_values #=> Array
resp.proxy_rule_group.rules.pre_dns[0].conditions[0].condition_values[0] #=> String
resp.proxy_rule_group.rules.pre_request #=> Array
resp.proxy_rule_group.rules.pre_request[0].proxy_rule_name #=> String
resp.proxy_rule_group.rules.pre_request[0].description #=> String
resp.proxy_rule_group.rules.pre_request[0].action #=> String, one of "ALLOW", "DENY", "ALERT"
resp.proxy_rule_group.rules.pre_request[0].conditions #=> Array
resp.proxy_rule_group.rules.pre_request[0].conditions[0].condition_operator #=> String
resp.proxy_rule_group.rules.pre_request[0].conditions[0].condition_key #=> String
resp.proxy_rule_group.rules.pre_request[0].conditions[0].condition_values #=> Array
resp.proxy_rule_group.rules.pre_request[0].conditions[0].condition_values[0] #=> String
resp.proxy_rule_group.rules.post_response #=> Array
resp.proxy_rule_group.rules.post_response[0].proxy_rule_name #=> String
resp.proxy_rule_group.rules.post_response[0].description #=> String
resp.proxy_rule_group.rules.post_response[0].action #=> String, one of "ALLOW", "DENY", "ALERT"
resp.proxy_rule_group.rules.post_response[0].conditions #=> Array
resp.proxy_rule_group.rules.post_response[0].conditions[0].condition_operator #=> String
resp.proxy_rule_group.rules.post_response[0].conditions[0].condition_key #=> String
resp.proxy_rule_group.rules.post_response[0].conditions[0].condition_values #=> Array
resp.proxy_rule_group.rules.post_response[0].conditions[0].condition_values[0] #=> String
resp.proxy_rule_group.description #=> String
resp.proxy_rule_group.tags #=> Array
resp.proxy_rule_group.tags[0].key #=> String
resp.proxy_rule_group.tags[0].value #=> String
resp.update_token #=> String

    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :proxy_rule_group_name
          (String)
          
            
          
          
            — 
    The descriptive name of the proxy rule group. You can't change the
name of a proxy rule group after you create it.
    

    You must specify the ARN or the name, and you can specify both.
    
          
        
    • 
      
        
  • 
          :proxy_rule_group_arn
          (String)
          
            
          
          
            — 
    The Amazon Resource Name (ARN) of a proxy rule group.
    

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

  
    
    


Returns:



  
See Also:

  



  

    
      


738

    		
    
      
# File 'sig/client.rbs', line 738

def describe_proxy_rule_group: (

    		
  





    
      

  

  
    #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:

  



  

    
      


749

    		
    
      
# File 'sig/client.rbs', line 749

def describe_resource_policy: (

    		
  





    
      

  

  
    #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, STATEFUL_DOMAIN
  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", "REJECTLIST", "ALERTLIST"
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", "HTTP2", "QUIC"
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", "STATEFUL_DOMAIN"
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
resp.rule_group_response.summary_configuration.rule_options #=> Array
resp.rule_group_response.summary_configuration.rule_options[0] #=> String, one of "SID", "MSG", "METADATA"

    
  


  

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:

  



  

    
      


761

    		
    
      
# File 'sig/client.rbs', line 761

def describe_rule_group: (

    		
  





    
      

  

  
    #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, STATEFUL_DOMAIN
})

    
      
        
Response structure

      
      

resp.rule_group_arn #=> String
resp.rule_group_name #=> String
resp.description #=> String
resp.type #=> String, one of "STATELESS", "STATEFUL", "STATEFUL_DOMAIN"
resp.capacity #=> Integer
resp.stateful_rule_options.rule_order #=> String, one of "DEFAULT_ACTION_ORDER", "STRICT_ORDER"
resp.last_modified_time #=> Time
resp.vendor_name #=> String
resp.product_id #=> String
resp.listing_name #=> 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 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:

  



  

    
      


783

    		
    
      
# File 'sig/client.rbs', line 783

def describe_rule_group_metadata: (

    		
  





    
      

  

  
    #describe_rule_group_summary(params = {})  ⇒ Types::DescribeRuleGroupSummaryResponse 
  

  

  


  

    
Returns detailed information for a stateful rule group.


For active threat defense Amazon Web Services managed rule groups,
this operation provides insight into the protections enabled by the
rule group, based on Suricata rule metadata fields. Summaries are
available for rule groups you manage and for active threat defense
Amazon Web Services managed rule groups.


To modify how threat information appears in summaries, use the
SummaryConfiguration parameter in UpdateRuleGroup.


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

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

    
      
        
Response structure

      
      

resp.rule_group_name #=> String
resp.description #=> String
resp.summary.rule_summaries #=> Array
resp.summary.rule_summaries[0].sid #=> String
resp.summary.rule_summaries[0].msg #=> String
resp.summary.rule_summaries[0].metadata #=> 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)
          
            
          
          
            — 
    Required. The Amazon Resource Name (ARN) of the rule group.
    

    You must specify the ARN or the name, and you can specify both.
    
          
        
    • 
      
        
  • 
          :type
          (String)
          
            
          
          
            — 
    The type of rule group you want a summary for. This is a required
field.
    

    Valid value: STATEFUL
    

    Note that STATELESS exists but is not currently supported. If you
provide STATELESS, an exception is returned.
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


797

    		
    
      
# File 'sig/client.rbs', line 797

def describe_rule_group_summary: (

    		
  





    
      

  

  
    #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:

  



  

    
      


811

    		
    
      
# File 'sig/client.rbs', line 811

def describe_tls_inspection_configuration: (

    		
  





    
      

  

  
    #describe_vpc_endpoint_association(params = {})  ⇒ Types::DescribeVpcEndpointAssociationResponse 
  

  

  


  

    
Returns the data object for the specified VPC endpoint association.


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.describe_vpc_endpoint_association({
  vpc_endpoint_association_arn: "ResourceArn", # required
})

    
      
        
Response structure

      
      

resp.vpc_endpoint_association.vpc_endpoint_association_id #=> String
resp.vpc_endpoint_association.vpc_endpoint_association_arn #=> String
resp.vpc_endpoint_association.firewall_arn #=> String
resp.vpc_endpoint_association.vpc_id #=> String
resp.vpc_endpoint_association.subnet_mapping.subnet_id #=> String
resp.vpc_endpoint_association.subnet_mapping.ip_address_type #=> String, one of "DUALSTACK", "IPV4", "IPV6"
resp.vpc_endpoint_association.description #=> String
resp.vpc_endpoint_association.tags #=> Array
resp.vpc_endpoint_association.tags[0].key #=> String
resp.vpc_endpoint_association.tags[0].value #=> String
resp.vpc_endpoint_association_status.status #=> String, one of "PROVISIONING", "DELETING", "READY"
resp.vpc_endpoint_association_status.association_sync_state #=> Hash
resp.vpc_endpoint_association_status.association_sync_state["AvailabilityZone"].attachment.subnet_id #=> String
resp.vpc_endpoint_association_status.association_sync_state["AvailabilityZone"].attachment.endpoint_id #=> String
resp.vpc_endpoint_association_status.association_sync_state["AvailabilityZone"].attachment.status #=> String, one of "CREATING", "DELETING", "FAILED", "ERROR", "SCALING", "READY"
resp.vpc_endpoint_association_status.association_sync_state["AvailabilityZone"].attachment.status_message #=> String

    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :vpc_endpoint_association_arn
          (required, String)
          
            
          
          
            — 
    The Amazon Resource Name (ARN) of a VPC endpoint association.
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


823

    		
    
      
# File 'sig/client.rbs', line 823

def describe_vpc_endpoint_association: (

    		
  





    
      

  

  
    #detach_rule_groups_from_proxy_configuration(params = {})  ⇒ Types::DetachRuleGroupsFromProxyConfigurationResponse 
  

  

  


  

    
Detaches ProxyRuleGroup resources from a ProxyConfiguration


A Proxy Configuration defines the monitoring and protection behavior
for a Proxy. The details of the behavior are defined in the rule
groups that you add to your configuration.


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.detach_rule_groups_from_proxy_configuration({
  proxy_configuration_name: "ResourceName",
  proxy_configuration_arn: "ResourceArn",
  rule_group_names: ["ResourceName"],
  rule_group_arns: ["ResourceArn"],
  update_token: "UpdateToken", # required
})

    
      
        
Response structure

      
      

resp.proxy_configuration.proxy_configuration_name #=> String
resp.proxy_configuration.proxy_configuration_arn #=> String
resp.proxy_configuration.description #=> String
resp.proxy_configuration.create_time #=> Time
resp.proxy_configuration.delete_time #=> Time
resp.proxy_configuration.rule_groups #=> Array
resp.proxy_configuration.rule_groups[0].proxy_rule_group_name #=> String
resp.proxy_configuration.rule_groups[0].proxy_rule_group_arn #=> String
resp.proxy_configuration.rule_groups[0].type #=> String
resp.proxy_configuration.rule_groups[0].priority #=> Integer
resp.proxy_configuration.default_rule_phase_actions.pre_dns #=> String, one of "ALLOW", "DENY", "ALERT"
resp.proxy_configuration.default_rule_phase_actions.pre_request #=> String, one of "ALLOW", "DENY", "ALERT"
resp.proxy_configuration.default_rule_phase_actions.post_response #=> String, one of "ALLOW", "DENY", "ALERT"
resp.proxy_configuration.tags #=> Array
resp.proxy_configuration.tags[0].key #=> String
resp.proxy_configuration.tags[0].value #=> String
resp.update_token #=> String

    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :proxy_configuration_name
          (String)
          
            
          
          
            — 
    The descriptive name of the proxy configuration. You can't change the
name of a proxy configuration after you create it.
    

    You must specify the ARN or the name, and you can specify both.
    
          
        
    • 
      
        
  • 
          :proxy_configuration_arn
          (String)
          
            
          
          
            — 
    The Amazon Resource Name (ARN) of a proxy configuration.
    

    You must specify the ARN or the name, and you can specify both.
    
          
        
    • 
      
        
  • 
          :rule_group_names
          (Array<String>)
          
            
          
          
            — 
    The proxy rule group names to detach from the proxy configuration
    
          
        
    • 
      
        
  • 
          :rule_group_arns
          (Array<String>)
          
            
          
          
            — 
    The proxy rule group arns to detach from the proxy configuration
    
          
        
    • 
      
        
  • 
          :update_token
          (required, String)
          
            
          
          
            — 
    A token used for optimistic locking. Network Firewall returns a token
to your requests that access the proxy configuration. The token marks
the state of the proxy configuration resource at the time of the
request.
    

    To make changes to the proxy configuration, you provide the token in
your request. Network Firewall uses the token to ensure that the proxy
configuration hasn't changed since you last retrieved it. If it has
changed, the operation fails with an InvalidTokenException. If this
happens, retrieve the proxy 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:

  



  

    
      


834

    		
    
      
# File 'sig/client.rbs', line 834

def detach_rule_groups_from_proxy_configuration: (

    		
  





    
      

  

  
    #disassociate_availability_zones(params = {})  ⇒ Types::DisassociateAvailabilityZonesResponse 
  

  

  


  

    
Removes the specified Availability Zone associations from a transit
gateway-attached firewall. This removes the firewall endpoints from
these Availability Zones and stops traffic filtering in those zones.
Before removing an Availability Zone, ensure you've updated your
transit gateway route tables to redirect traffic appropriately.


 If AvailabilityZoneChangeProtection is enabled, you must first
disable it using UpdateAvailabilityZoneChangeProtection.

 

To verify the status of your Availability Zone changes, use
DescribeFirewall.


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.disassociate_availability_zones({
  update_token: "UpdateToken",
  firewall_arn: "ResourceArn",
  firewall_name: "ResourceName",
  availability_zone_mappings: [ # required
    {
      availability_zone: "AvailabilityZoneMappingString", # required
    },
  ],
})

    
      
        
Response structure

      
      

resp.firewall_arn #=> String
resp.firewall_name #=> String
resp.availability_zone_mappings #=> Array
resp.availability_zone_mappings[0].availability_zone #=> 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.
    
          
        
    • 
      
        
  • 
          :availability_zone_mappings
          (required, Array<Types::AvailabilityZoneMapping>)
          
            
          
          
            — 
    Required. The Availability Zones to remove from the firewall's
configuration.
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


851

    		
    
      
# File 'sig/client.rbs', line 851

def disassociate_availability_zones: (

    		
  





    
      

  

  
    #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:

  



  

    
      


871

    		
    
      
# File 'sig/client.rbs', line 871

def disassociate_subnets: (

    		
  





    
      

  

  
    #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:

  



  

    
      


890

    		
    
      
# File 'sig/client.rbs', line 890

def get_analysis_report_results: (

    		
  





    
      

  

  
    #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:

  



  

    
      


905

    		
    
      
# File 'sig/client.rbs', line 905

def list_analysis_reports: (

    		
  





    
      

  

  
    #list_container_associations(params = {})  ⇒ Types::ListContainerAssociationsResponse 
  

  

  


  

    
Retrieves the metadata for the container associations that you have
defined. You can optionally page through results.


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_container_associations({
  max_results: 1,
  next_token: "PaginationToken",
})

    
      
        
Response structure

      
      

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

    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

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

  
    
    


Returns:



  
See Also:

  



  

    
      


919

    		
    
      
# File 'sig/client.rbs', line 919

def list_container_associations: (

    		
  





    
      

  

  
    #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:

  



  

    
      


931

    		
    
      
# File 'sig/client.rbs', line 931

def list_firewall_policies: (

    		
  





    
      

  

  
    #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
resp.firewalls[0].transit_gateway_attachment_id #=> 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:

  



  

    
      


943

    		
    
      
# File 'sig/client.rbs', line 943

def list_firewalls: (

    		
  





    
      

  

  
    #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",
  vpc_endpoint_id: "VpcEndpointId",
  vpc_endpoint_association_arn: "ResourceArn",
})

    
      
        
Response structure

      
      

resp.firewall_arn #=> String
resp.availability_zone #=> String
resp.vpc_endpoint_association_arn #=> String
resp.vpc_endpoint_id #=> 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.
    
          
        
    • 
      
        
  • 
          :vpc_endpoint_id
          (String)
          
            
          
          
            — 
    A unique identifier for the primary endpoint associated with a
firewall.
    
          
        
    • 
      
        
  • 
          :vpc_endpoint_association_arn
          (String)
          
            
          
          
            — 
    The Amazon Resource Name (ARN) of a VPC endpoint association.
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


964

    		
    
      
# File 'sig/client.rbs', line 964

def list_flow_operation_results: (

    		
  





    
      

  

  
    #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",
  vpc_endpoint_association_arn: "ResourceArn",
  vpc_endpoint_id: "VpcEndpointId",
  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.
    
          
        
    • 
      
        
  • 
          :vpc_endpoint_association_arn
          (String)
          
            
          
          
            — 
    The Amazon Resource Name (ARN) of a VPC endpoint association.
    
          
        
    • 
      
        
  • 
          :vpc_endpoint_id
          (String)
          
            
          
          
            — 
    A unique identifier for the primary endpoint associated with a
firewall.
    
          
        
    • 
      
        
  • 
          :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:

  



  

    
      


981

    		
    
      
# File 'sig/client.rbs', line 981

def list_flow_operations: (

    		
  





    
      

  

  
    #list_proxies(params = {})  ⇒ Types::ListProxiesResponse 
  

  

  


  

    
Retrieves the metadata for the proxies that you have defined.
Depending on your setting for max results and the number of proxies, 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_proxies({
  next_token: "PaginationToken",
  max_results: 1,
})

    
      
        
Response structure

      
      

resp.proxies #=> Array
resp.proxies[0].name #=> String
resp.proxies[0].arn #=> String
resp.next_token #=> 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:

  



  

    
      


998

    		
    
      
# File 'sig/client.rbs', line 998

def list_proxies: (

    		
  





    
      

  

  
    #list_proxy_configurations(params = {})  ⇒ Types::ListProxyConfigurationsResponse 
  

  

  


  

    
Retrieves the metadata for the proxy configuration that you have
defined. Depending on your setting for max results and the number of
proxy 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_proxy_configurations({
  next_token: "PaginationToken",
  max_results: 1,
})

    
      
        
Response structure

      
      

resp.proxy_configurations #=> Array
resp.proxy_configurations[0].name #=> String
resp.proxy_configurations[0].arn #=> String
resp.next_token #=> 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:

  



  

    
      


1010

    		
    
      
# File 'sig/client.rbs', line 1010

def list_proxy_configurations: (

    		
  





    
      

  

  
    #list_proxy_rule_groups(params = {})  ⇒ Types::ListProxyRuleGroupsResponse 
  

  

  


  

    
Retrieves the metadata for the proxy rule groups that you have
defined. Depending on your setting for max results and the number of
proxy 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_proxy_rule_groups({
  next_token: "PaginationToken",
  max_results: 1,
})

    
      
        
Response structure

      
      

resp.proxy_rule_groups #=> Array
resp.proxy_rule_groups[0].name #=> String
resp.proxy_rule_groups[0].arn #=> String
resp.next_token #=> 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:

  



  

    
      


1022

    		
    
      
# File 'sig/client.rbs', line 1022

def list_proxy_rule_groups: (

    		
  





    
      

  

  
    #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, ACTIVE_THREAT_DEFENSE, PARTNER_MANAGED
  subscription_status: "NOT_SUBSCRIBED", # accepts NOT_SUBSCRIBED, SUBSCRIBED
  type: "STATELESS", # accepts STATELESS, STATEFUL, STATEFUL_DOMAIN
})

    
      
        
Response structure

      
      

resp.next_token #=> String
resp.rule_groups #=> Array
resp.rule_groups[0].name #=> String
resp.rule_groups[0].arn #=> String
resp.rule_groups[0].vendor_name #=> 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.
    
          
        
    • 
      
        
  • 
          :subscription_status
          (String)
          
            
          
          
            — 
    Filters the results to show only rule groups with the specified
subscription status. Use this to find subscribed or unsubscribed rule
groups.
    
          
        
    • 
      
        
  • 
          :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:

  



  

    
      


1034

    		
    
      
# File 'sig/client.rbs', line 1034

def list_rule_groups: (

    		
  





    
      

  

  
    #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:

  



  

    
      


1062

    		
    
      
# File 'sig/client.rbs', line 1062

def list_tags_for_resource: (

    		
  





    
      

  

  
    #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:

  



  

    
      


1050

    		
    
      
# File 'sig/client.rbs', line 1050

def list_tls_inspection_configurations: (

    		
  





    
      

  

  
    #list_vpc_endpoint_associations(params = {})  ⇒ Types::ListVpcEndpointAssociationsResponse 
  

  

  


  

    
Retrieves the metadata for the VPC endpoint associations that you have
defined. If you specify a fireawll, this returns only the endpoint
associations for that firewall.


Depending on your setting for max results and the number of
associations, 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_vpc_endpoint_associations({
  next_token: "PaginationToken",
  max_results: 1,
  firewall_arn: "ResourceArn",
})

    
      
        
Response structure

      
      

resp.next_token #=> String
resp.vpc_endpoint_associations #=> Array
resp.vpc_endpoint_associations[0].vpc_endpoint_association_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.
    
          
        
    • 
      
        
  • 
          :firewall_arn
          (String)
          
            
          
          
            — 
    The Amazon Resource Name (ARN) of the firewall.
    

    If you don't specify this, Network Firewall retrieves all VPC
endpoint associations that you have defined.
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


1075

    		
    
      
# File 'sig/client.rbs', line 1075

def list_vpc_endpoint_associations: (

    		
  





    
      

  

  
    #put_resource_policy(params = {})  ⇒ Struct 
  

  

  


  

    
Creates or updates an IAM policy for your rule group, firewall policy,
or firewall. Use this to share these resources between accounts. This
operation works in conjunction with the Amazon Web Services Resource
Access Manager (RAM) service to manage resource sharing for Network
Firewall.


For information about using sharing with Network Firewall resources,
see Sharing Network Firewall resources in the Network Firewall
Developer Guide.


Use this operation to create or update a resource policy for your
Network Firewall rule group, firewall policy, or firewall. In the
resource policy, you specify the accounts that you want to share the
Network Firewall resource with and the operations that you want the
accounts to be able to perform.


When you add an account in the resource policy, you then run the
following Resource Access Manager (RAM) operations to access and
accept the shared resource.



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
your Network Firewall resources with.
    
          
        
    • 
      
        
  • 
          :policy
          (required, String)
          
            
          
          
            — 
    The IAM policy statement that lists the accounts that you want to
share your Network Firewall resources 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
      

      • 

    

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

      

    • 

      network-firewall:CreateVpcEndpointAssociation
      

      • 

    • 

      network-firewall:DescribeFirewallMetadata
      

      • 

    • 

      network-firewall:ListFirewalls
      

      • 

    

    In the Resource section of the statement, you specify the ARNs for the
Network Firewall resources that you want to share with the account
that you specified in Arn.
    
          
        
    • 
      
    

  
    
    


Returns:


    
  
    
  • 
      
      
        (Struct)
      
      
      
        —
        
    Returns an empty response.
    
      
    
    • 
  



  
See Also:

  



  

    
      


1086

    		
    
      
# File 'sig/client.rbs', line 1086

def put_resource_policy: (

    		
  





    
      

  

  
    #reject_network_firewall_transit_gateway_attachment(params = {})  ⇒ Types::RejectNetworkFirewallTransitGatewayAttachmentResponse 
  

  

  


  

    
Rejects a transit gateway attachment request for Network Firewall.
When you reject the attachment request, Network Firewall cancels the
creation of routing components between the transit gateway and
firewall endpoints.


Only the transit gateway owner can reject the attachment. After
rejection, no traffic will flow through the firewall endpoints for
this attachment.


Use DescribeFirewall to monitor the rejection status. To accept the
attachment instead of rejecting it, use
AcceptNetworkFirewallTransitGatewayAttachment.


 Once rejected, you cannot reverse this action. To establish
connectivity, you must create a new transit gateway-attached firewall.

 

  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.reject_network_firewall_transit_gateway_attachment({
  transit_gateway_attachment_id: "TransitGatewayAttachmentId", # required
})

    
      
        
Response structure

      
      

resp.transit_gateway_attachment_id #=> String
resp.transit_gateway_attachment_status #=> String, one of "CREATING", "DELETING", "DELETED", "FAILED", "ERROR", "READY", "PENDING_ACCEPTANCE", "REJECTING", "REJECTED"

    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :transit_gateway_attachment_id
          (required, String)
          
            
          
          
            — 
    Required. The unique identifier of the transit gateway attachment to
reject. This ID is returned in the response when creating a transit
gateway-attached firewall.
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


1098

    		
    
      
# File 'sig/client.rbs', line 1098

def reject_network_firewall_transit_gateway_attachment: (

    		
  





    
      

  

  
    #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:

  



  

    
      


1108

    		
    
      
# File 'sig/client.rbs', line 1108

def start_analysis_report: (

    		
  





    
      

  

  
    #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",
  vpc_endpoint_association_arn: "ResourceArn",
  vpc_endpoint_id: "VpcEndpointId",
  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.
    
          
        
    • 
      
        
  • 
          :vpc_endpoint_association_arn
          (String)
          
            
          
          
            — 
    The Amazon Resource Name (ARN) of a VPC endpoint association.
    
          
        
    • 
      
        
  • 
          :vpc_endpoint_id
          (String)
          
            
          
          
            — 
    A unique identifier for the primary endpoint associated with a
firewall.
    
          
        
    • 
      
        
  • 
          :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:

  



  

    
      


1122

    		
    
      
# File 'sig/client.rbs', line 1122

def start_flow_capture: (

    		
  





    
      

  

  
    #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",
  vpc_endpoint_association_arn: "ResourceArn",
  vpc_endpoint_id: "VpcEndpointId",
  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.
    
          
        
    • 
      
        
  • 
          :vpc_endpoint_association_arn
          (String)
          
            
          
          
            — 
    The Amazon Resource Name (ARN) of a VPC endpoint association.
    
          
        
    • 
      
        
  • 
          :vpc_endpoint_id
          (String)
          
            
          
          
            — 
    A unique identifier for the primary endpoint associated with a
firewall.
    
          
        
    • 
      
        
  • 
          :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:

  



  

    
      


1141

    		
    
      
# File 'sig/client.rbs', line 1141

def start_flow_flush: (

    		
  





    
      

  

  
    #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:

  



  

    
      


1157

    		
    
      
# File 'sig/client.rbs', line 1157

def tag_resource: (

    		
  





    
      

  

  
    #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:

  



  

    
      


1172

    		
    
      
# File 'sig/client.rbs', line 1172

def untag_resource: (

    		
  





    
      

  

  
    #update_availability_zone_change_protection(params = {})  ⇒ Types::UpdateAvailabilityZoneChangeProtectionResponse 
  

  

  


  

    
Modifies the AvailabilityZoneChangeProtection setting for a transit
gateway-attached firewall. When enabled, this setting prevents
accidental changes to the firewall's Availability Zone configuration.
This helps protect against disrupting traffic flow in production
environments.


When enabled, you must disable this protection before using
AssociateAvailabilityZones or DisassociateAvailabilityZones to modify
the firewall's Availability Zone configuration.


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

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

    
      
        
Response structure

      
      

resp.update_token #=> String
resp.firewall_arn #=> String
resp.firewall_name #=> String
resp.availability_zone_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.
    
          
        
    • 
      
        
  • 
          :availability_zone_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:

  



  

    
      


1186

    		
    
      
# File 'sig/client.rbs', line 1186

def update_availability_zone_change_protection: (

    		
  





    
      

  

  
    #update_container_association(params = {})  ⇒ Types::UpdateContainerAssociationResponse 
  

  

  


  

    
Updates the properties of an existing container association. Use this
to modify the container monitoring configurations or description.


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.update_container_association({
  container_association_name: "ResourceName",
  container_association_arn: "ResourceArn",
  description: "Description",
  type: "ECS", # required, accepts ECS, EKS
  container_monitoring_configurations: [ # required
    {
      cluster_arn: "ResourceArn", # required
      attribute_filters: [
        {
          key: "ContainerAttributeKey", # required
          value: "ContainerAttributeValue", # required
        },
      ],
    },
  ],
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
  update_token: "UpdateToken", # required
})

    
      
        
Response structure

      
      

resp.container_association_name #=> String
resp.container_association_arn #=> String
resp.description #=> String
resp.type #=> String, one of "ECS", "EKS"
resp.container_monitoring_configurations #=> Array
resp.container_monitoring_configurations[0].cluster_arn #=> String
resp.container_monitoring_configurations[0].attribute_filters #=> Array
resp.container_monitoring_configurations[0].attribute_filters[0].key #=> String
resp.container_monitoring_configurations[0].attribute_filters[0].value #=> String
resp.status #=> String, one of "ACTIVE", "CREATING", "DELETING", "UPDATING"
resp.tags #=> Array
resp.tags[0].key #=> String
resp.tags[0].value #=> String
resp.update_token #=> String

    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :container_association_name
          (String)
          
            
          
          
            — 
    The descriptive name of the container association. You must specify
the ARN or the name, and you can specify both.
    
          
        
    • 
      
        
  • 
          :container_association_arn
          (String)
          
            
          
          
            — 
    The Amazon Resource Name (ARN) of the container association. You must
specify the ARN or the name, and you can specify both.
    
          
        
    • 
      
        
  • 
          :description
          (String)
          
            
          
          
            — 
    A description of the container association.
    
          
        
    • 
      
        
  • 
          :type
          (required, String)
          
            
          
          
            — 
    The type of container orchestration platform. This must match the type
specified when the container association was created.
    
          
        
    • 
      
        
  • 
          :container_monitoring_configurations
          (required, Array<Types::ContainerMonitoringConfiguration>)
          
            
          
          
            — 
    The updated list of container monitoring configurations that define
which clusters and container attributes to monitor.
    
          
        
    • 
      
        
  • 
          :tags
          (Array<Types::Tag>)
          
            
          
          
            — 
    The key:value pairs associated with the resource.
    
          
        
    • 
      
        
  • 
          :update_token
          (required, String)
          
            
          
          
            — 
    A token used for optimistic locking. Network Firewall returns a token
to your requests that access the container association. The token
marks the state of the container association resource at the time of
the request. To make an update to the container association, provide
the token in your request. Network Firewall uses the token to ensure
that the container association hasn't changed since you last
retrieved it. If it has changed, the operation fails with an
InvalidTokenException. If this happens, retrieve the container
association 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:

  



  

    
      


1206

    		
    
      
# File 'sig/client.rbs', line 1206

def update_container_association: (

    		
  





    
      

  

  
    #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:

  



  

    
      


1240

    		
    
      
# File 'sig/client.rbs', line 1240

def update_firewall_analysis_settings: (

    		
  





    
      

  

  
    #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:

  



  

    
      


1256

    		
    
      
# File 'sig/client.rbs', line 1256

def update_firewall_delete_protection: (

    		
  





    
      

  

  
    #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:

  



  

    
      


1272

    		
    
      
# File 'sig/client.rbs', line 1272

def update_firewall_description: (

    		
  





    
      

  

  
    #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:

  



  

    
      


1288

    		
    
      
# File 'sig/client.rbs', line 1288

def update_firewall_encryption_configuration: (

    		
  





    
      

  

  
    #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
        },
        deep_threat_inspection: false,
      },
    ],
    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
        },
      },
    },
    enable_tls_session_holding: false,
  },
  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.consumed_stateful_domain_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:

  



  

    
      


1305

    		
    
      
# File 'sig/client.rbs', line 1305

def update_firewall_policy: (

    		
  





    
      

  

  
    #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:

  



  

    
      


1327

    		
    
      
# File 'sig/client.rbs', line 1327

def update_firewall_policy_change_protection: (

    		
  





    
      

  

  
    #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",
        },
      },
    ],
  },
  enable_monitoring_dashboard: false,
})

    
      
        
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
resp.enable_monitoring_dashboard #=> Boolean

    
  


  

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.
    
          
        
    • 
      
        
  • 
          :enable_monitoring_dashboard
          (Boolean)
          
            
          
          
            — 
    A boolean that lets you enable or disable the detailed firewall
monitoring dashboard on the firewall.
    

    The monitoring dashboard provides comprehensive visibility into your
firewall's flow logs and alert logs. After you enable detailed
monitoring, you can access these dashboards directly from the
Monitoring page of the Network Firewall console.
    

    Specify TRUE to enable the the detailed monitoring dashboard on the
firewall. Specify FALSE to disable the the detailed monitoring
dashboard on the firewall.
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


1343

    		
    
      
# File 'sig/client.rbs', line 1343

def update_logging_configuration: (

    		
  





    
      

  

  
    #update_proxy(params = {})  ⇒ Types::UpdateProxyResponse 
  

  

  


  

    
Updates the properties of the specified proxy.


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.update_proxy({
  nat_gateway_id: "NatGatewayId", # required
  proxy_name: "ResourceName",
  proxy_arn: "ResourceArn",
  listener_properties_to_add: [
    {
      port: 1, # required
      type: "HTTP", # required, accepts HTTP, HTTPS
    },
  ],
  listener_properties_to_remove: [
    {
      port: 1, # required
      type: "HTTP", # required, accepts HTTP, HTTPS
    },
  ],
  tls_intercept_properties: {
    pca_arn: "ResourceArn",
    tls_intercept_mode: "ENABLED", # accepts ENABLED, DISABLED
  },
  update_token: "UpdateToken", # required
})

    
      
        
Response structure

      
      

resp.proxy.create_time #=> Time
resp.proxy.delete_time #=> Time
resp.proxy.update_time #=> Time
resp.proxy.failure_code #=> String
resp.proxy.failure_message #=> String
resp.proxy.proxy_state #=> String, one of "ATTACHING", "ATTACHED", "DETACHING", "DETACHED", "ATTACH_FAILED", "DETACH_FAILED"
resp.proxy.proxy_modify_state #=> String, one of "MODIFYING", "COMPLETED", "FAILED"
resp.proxy.nat_gateway_id #=> String
resp.proxy.proxy_configuration_name #=> String
resp.proxy.proxy_configuration_arn #=> String
resp.proxy.proxy_name #=> String
resp.proxy.proxy_arn #=> String
resp.proxy.listener_properties #=> Array
resp.proxy.listener_properties[0].port #=> Integer
resp.proxy.listener_properties[0].type #=> String, one of "HTTP", "HTTPS"
resp.proxy.tls_intercept_properties.pca_arn #=> String
resp.proxy.tls_intercept_properties.tls_intercept_mode #=> String, one of "ENABLED", "DISABLED"
resp.proxy.tags #=> Array
resp.proxy.tags[0].key #=> String
resp.proxy.tags[0].value #=> String
resp.update_token #=> String

    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :nat_gateway_id
          (required, String)
          
            
          
          
            — 
    The NAT Gateway the proxy is attached to.
    
          
        
    • 
      
        
  • 
          :proxy_name
          (String)
          
            
          
          
            — 
    The descriptive name of the proxy. You can't change the name of a
proxy after you create it.
    

    You must specify the ARN or the name, and you can specify both.
    
          
        
    • 
      
        
  • 
          :proxy_arn
          (String)
          
            
          
          
            — 
    The Amazon Resource Name (ARN) of a proxy.
    

    You must specify the ARN or the name, and you can specify both.
    
          
        
    • 
      
        
  • 
          :listener_properties_to_add
          (Array<Types::ListenerPropertyRequest>)
          
            
          
          
            — 
    Listener properties for HTTP and HTTPS traffic to add.
    
          
        
    • 
      
        
  • 
          :listener_properties_to_remove
          (Array<Types::ListenerPropertyRequest>)
          
            
          
          
            — 
    Listener properties for HTTP and HTTPS traffic to remove.
    
          
        
    • 
      
        
  • 
          :tls_intercept_properties
          (Types::TlsInterceptPropertiesRequest)
          
            
          
          
            — 
    TLS decryption on traffic to filter on attributes in the HTTP header.
    
          
        
    • 
      
        
  • 
          :update_token
          (required, String)
          
            
          
          
            — 
    A token used for optimistic locking. Network Firewall returns a token
to your requests that access the proxy. The token marks the state of
the proxy resource at the time of the request.
    

    To make changes to the proxy, you provide the token in your request.
Network Firewall uses the token to ensure that the proxy hasn't
changed since you last retrieved it. If it has changed, the operation
fails with an InvalidTokenException. If this happens, retrieve the
proxy 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:

  



  

    
      


1365

    		
    
      
# File 'sig/client.rbs', line 1365

def update_proxy: (

    		
  





    
      

  

  
    #update_proxy_configuration(params = {})  ⇒ Types::UpdateProxyConfigurationResponse 
  

  

  


  

    
Updates the properties of the specified proxy configuration.


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.update_proxy_configuration({
  proxy_configuration_name: "ResourceName",
  proxy_configuration_arn: "ResourceArn",
  default_rule_phase_actions: { # required
    pre_dns: "ALLOW", # accepts ALLOW, DENY, ALERT
    pre_request: "ALLOW", # accepts ALLOW, DENY, ALERT
    post_response: "ALLOW", # accepts ALLOW, DENY, ALERT
  },
  update_token: "UpdateToken", # required
})

    
      
        
Response structure

      
      

resp.proxy_configuration.proxy_configuration_name #=> String
resp.proxy_configuration.proxy_configuration_arn #=> String
resp.proxy_configuration.description #=> String
resp.proxy_configuration.create_time #=> Time
resp.proxy_configuration.delete_time #=> Time
resp.proxy_configuration.rule_groups #=> Array
resp.proxy_configuration.rule_groups[0].proxy_rule_group_name #=> String
resp.proxy_configuration.rule_groups[0].proxy_rule_group_arn #=> String
resp.proxy_configuration.rule_groups[0].type #=> String
resp.proxy_configuration.rule_groups[0].priority #=> Integer
resp.proxy_configuration.default_rule_phase_actions.pre_dns #=> String, one of "ALLOW", "DENY", "ALERT"
resp.proxy_configuration.default_rule_phase_actions.pre_request #=> String, one of "ALLOW", "DENY", "ALERT"
resp.proxy_configuration.default_rule_phase_actions.post_response #=> String, one of "ALLOW", "DENY", "ALERT"
resp.proxy_configuration.tags #=> Array
resp.proxy_configuration.tags[0].key #=> String
resp.proxy_configuration.tags[0].value #=> String
resp.update_token #=> String

    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :proxy_configuration_name
          (String)
          
            
          
          
            — 
    The descriptive name of the proxy configuration. You can't change the
name of a proxy configuration after you create it.
    

    You must specify the ARN or the name, and you can specify both.
    
          
        
    • 
      
        
  • 
          :proxy_configuration_arn
          (String)
          
            
          
          
            — 
    The Amazon Resource Name (ARN) of a proxy configuration.
    

    You must specify the ARN or the name, and you can specify both.
    
          
        
    • 
      
        
  • 
          :default_rule_phase_actions
          (required, Types::ProxyConfigDefaultRulePhaseActionsRequest)
          
            
          
          
            — 
    Evaluation points in the traffic flow where rules are applied. There
are three phases in a traffic where the rule match is applied.
    
          
        
    • 
      
        
  • 
          :update_token
          (required, String)
          
            
          
          
            — 
    A token used for optimistic locking. Network Firewall returns a token
to your requests that access the proxy configuration. The token marks
the state of the proxy configuration resource at the time of the
request.
    

    To make changes to the proxy configuration, you provide the token in
your request. Network Firewall uses the token to ensure that the proxy
configuration hasn't changed since you last retrieved it. If it has
changed, the operation fails with an InvalidTokenException. If this
happens, retrieve the proxy 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:

  



  

    
      


1395

    		
    
      
# File 'sig/client.rbs', line 1395

def update_proxy_configuration: (

    		
  





    
      

  

  
    #update_proxy_rule(params = {})  ⇒ Types::UpdateProxyRuleResponse 
  

  

  


  

    
Updates the properties of the specified proxy rule.


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.update_proxy_rule({
  proxy_rule_group_name: "ResourceName",
  proxy_rule_group_arn: "ResourceArn",
  proxy_rule_name: "ResourceName", # required
  description: "Description",
  action: "ALLOW", # accepts ALLOW, DENY, ALERT
  add_conditions: [
    {
      condition_operator: "ConditionOperator",
      condition_key: "ConditionKey",
      condition_values: ["ProxyConditionValue"],
    },
  ],
  remove_conditions: [
    {
      condition_operator: "ConditionOperator",
      condition_key: "ConditionKey",
      condition_values: ["ProxyConditionValue"],
    },
  ],
  update_token: "UpdateToken", # required
})

    
      
        
Response structure

      
      

resp.proxy_rule.proxy_rule_name #=> String
resp.proxy_rule.description #=> String
resp.proxy_rule.action #=> String, one of "ALLOW", "DENY", "ALERT"
resp.proxy_rule.conditions #=> Array
resp.proxy_rule.conditions[0].condition_operator #=> String
resp.proxy_rule.conditions[0].condition_key #=> String
resp.proxy_rule.conditions[0].condition_values #=> Array
resp.proxy_rule.conditions[0].condition_values[0] #=> String
resp.removed_conditions #=> Array
resp.removed_conditions[0].condition_operator #=> String
resp.removed_conditions[0].condition_key #=> String
resp.removed_conditions[0].condition_values #=> Array
resp.removed_conditions[0].condition_values[0] #=> String
resp.update_token #=> String

    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :proxy_rule_group_name
          (String)
          
            
          
          
            — 
    The descriptive name of the proxy rule group. You can't change the
name of a proxy rule group after you create it.
    

    You must specify the ARN or the name, and you can specify both.
    
          
        
    • 
      
        
  • 
          :proxy_rule_group_arn
          (String)
          
            
          
          
            — 
    The Amazon Resource Name (ARN) of a proxy rule group.
    

    You must specify the ARN or the name, and you can specify both.
    
          
        
    • 
      
        
  • 
          :proxy_rule_name
          (required, String)
          
            
          
          
            — 
    The descriptive name of the proxy rule. You can't change the name of
a proxy rule after you create it.
    
          
        
    • 
      
        
  • 
          :description
          (String)
          
            
          
          
            — 
    A description of the proxy rule.
    
          
        
    • 
      
        
  • 
          :action
          (String)
          
            
          
          
            — 
    Depending on the match action, the proxy either stops the evaluation
(if the action is terminal - allow or deny), or continues it (if the
action is alert) until it matches a rule with a terminal action.
    
          
        
    • 
      
        
  • 
          :add_conditions
          (Array<Types::ProxyRuleCondition>)
          
            
          
          
            — 
    Proxy rule conditions to add. Match criteria that specify what traffic
attributes to examine. Conditions include operators (StringEquals,
StringLike) and values to match against.
    
          
        
    • 
      
        
  • 
          :remove_conditions
          (Array<Types::ProxyRuleCondition>)
          
            
          
          
            — 
    Proxy rule conditions to remove. Match criteria that specify what
traffic attributes to examine. Conditions include operators
(StringEquals, StringLike) and values to match against.
    
          
        
    • 
      
        
  • 
          :update_token
          (required, String)
          
            
          
          
            — 
    A token used for optimistic locking. Network Firewall returns a token
to your requests that access the proxy rule. The token marks the state
of the proxy rule resource at the time of the request.
    

    To make changes to the proxy rule, you provide the token in your
request. Network Firewall uses the token to ensure that the proxy rule
hasn't changed since you last retrieved it. If it has changed, the
operation fails with an InvalidTokenException. If this happens,
retrieve the proxy rule 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:

  



  

    
      


1414

    		
    
      
# File 'sig/client.rbs', line 1414

def update_proxy_rule: (

    		
  





    
      

  

  
    #update_proxy_rule_group_priorities(params = {})  ⇒ Types::UpdateProxyRuleGroupPrioritiesResponse 
  

  

  


  

    
Updates proxy rule group priorities within a proxy configuration.


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.update_proxy_rule_group_priorities({
  proxy_configuration_name: "ResourceName",
  proxy_configuration_arn: "ResourceArn",
  rule_groups: [ # required
    {
      proxy_rule_group_name: "ResourceName",
      new_position: 1,
    },
  ],
  update_token: "UpdateToken", # required
})

    
      
        
Response structure

      
      

resp.proxy_rule_groups #=> Array
resp.proxy_rule_groups[0].proxy_rule_group_name #=> String
resp.proxy_rule_groups[0].priority #=> Integer
resp.update_token #=> String

    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :proxy_configuration_name
          (String)
          
            
          
          
            — 
    The descriptive name of the proxy configuration. You can't change the
name of a proxy configuration after you create it.
    

    You must specify the ARN or the name, and you can specify both.
    
          
        
    • 
      
        
  • 
          :proxy_configuration_arn
          (String)
          
            
          
          
            — 
    The Amazon Resource Name (ARN) of a proxy configuration.
    

    You must specify the ARN or the name, and you can specify both.
    
          
        
    • 
      
        
  • 
          :rule_groups
          (required, Array<Types::ProxyRuleGroupPriority>)
          
            
          
          
            — 
    proxy rule group resources to update to new positions.
    
          
        
    • 
      
        
  • 
          :update_token
          (required, String)
          
            
          
          
            — 
    A token used for optimistic locking. Network Firewall returns a token
to your requests that access the proxy configuration. The token marks
the state of the proxy configuration resource at the time of the
request.
    

    To make changes to the proxy configuration, you provide the token in
your request. Network Firewall uses the token to ensure that the proxy
configuration hasn't changed since you last retrieved it. If it has
changed, the operation fails with an InvalidTokenException. If this
happens, retrieve the proxy 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:

  



  

    
      


1444

    		
    
      
# File 'sig/client.rbs', line 1444

def update_proxy_rule_group_priorities: (

    		
  





    
      

  

  
    #update_proxy_rule_priorities(params = {})  ⇒ Types::UpdateProxyRulePrioritiesResponse 
  

  

  


  

    
Updates proxy rule priorities within a proxy rule group.


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.update_proxy_rule_priorities({
  proxy_rule_group_name: "ResourceName",
  proxy_rule_group_arn: "ResourceArn",
  rule_group_request_phase: "PRE_DNS", # required, accepts PRE_DNS, PRE_REQ, POST_RES
  rules: [ # required
    {
      proxy_rule_name: "ResourceName",
      new_position: 1,
    },
  ],
  update_token: "UpdateToken", # required
})

    
      
        
Response structure

      
      

resp.proxy_rule_group_name #=> String
resp.proxy_rule_group_arn #=> String
resp.rule_group_request_phase #=> String, one of "PRE_DNS", "PRE_REQ", "POST_RES"
resp.rules #=> Array
resp.rules[0].proxy_rule_name #=> String
resp.rules[0].new_position #=> Integer
resp.update_token #=> String

    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :proxy_rule_group_name
          (String)
          
            
          
          
            — 
    The descriptive name of the proxy rule group. You can't change the
name of a proxy rule group after you create it.
    

    You must specify the ARN or the name, and you can specify both.
    
          
        
    • 
      
        
  • 
          :proxy_rule_group_arn
          (String)
          
            
          
          
            — 
    The Amazon Resource Name (ARN) of a proxy rule group.
    

    You must specify the ARN or the name, and you can specify both.
    
          
        
    • 
      
        
  • 
          :rule_group_request_phase
          (required, String)
          
            
          
          
            — 
    Evaluation points in the traffic flow where rules are applied. There
are three phases in a traffic where the rule match is applied.
    
          
        
    • 
      
        
  • 
          :rules
          (required, Array<Types::ProxyRulePriority>)
          
            
          
          
            — 
    proxy rule resources to update to new positions.
    
          
        
    • 
      
        
  • 
          :update_token
          (required, String)
          
            
          
          
            — 
    A token used for optimistic locking. Network Firewall returns a token
to your requests that access the proxy rule group. The token marks the
state of the proxy rule group resource at the time of the request.
    

    To make changes to the proxy rule group, you provide the token in your
request. Network Firewall uses the token to ensure that the proxy 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 proxy 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.
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


1466

    		
    
      
# File 'sig/client.rbs', line 1466

def update_proxy_rule_priorities: (

    		
  





    
      

  

  
    #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, REJECTLIST, ALERTLIST
      },
      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, HTTP2, QUIC
            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, STATEFUL_DOMAIN
  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,
  summary_configuration: {
    rule_options: ["SID"], # accepts SID, MSG, METADATA
  },
})

    
      
        
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", "STATEFUL_DOMAIN"
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
resp.rule_group_response.summary_configuration.rule_options #=> Array
resp.rule_group_response.summary_configuration.rule_options[0] #=> String, one of "SID", "MSG", "METADATA"

    
  


  

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.
    
          
        
    • 
      
        
  • 
          :summary_configuration
          (Types::SummaryConfiguration)
          
            
          
          
            — 
    Updates the selected summary configuration for a rule group.
    

    Changes affect subsequent responses from DescribeRuleGroupSummary.
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


1486

    		
    
      
# File 'sig/client.rbs', line 1486

def update_rule_group: (

    		
  





    
      

  

  
    #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:

  



  

    
      


1518

    		
    
      
# File 'sig/client.rbs', line 1518

def update_subnet_change_protection: (

    		
  





    
      

  

  
    #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:

  



  

    
      


1532

    		
    
      
# File 'sig/client.rbs', line 1532

def update_tls_inspection_configuration: (

    		
  





    
      

  

  
    #waiter_names  ⇒ Object 
  

  

  


  

    

  This method is part of a private API.
  You should avoid using this method if possible, as it may be removed or be changed in the future.



Deprecated. 



  





  



  

    
      


7271
7272
7273

    		
    
      
# File 'lib/aws-sdk-networkfirewall/client.rb', line 7271

def waiter_names
  []
end