Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

UpdateLoggingConfiguration

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.

Request Syntax


{
   "FirewallArn": "string",
   "FirewallName": "string",
   "LoggingConfiguration": { 
      "LogDestinationConfigs": [ 
         { 
            "LogDestination": { 
               "string" : "string" 
            },
            "LogDestinationType": "string",
            "LogType": "string"
         }
      ]
   }
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

FirewallArn

The Amazon Resource Name (ARN) of the firewall.

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

Pattern: ^arn:aws.*

Required: No

FirewallName

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.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: ^[a-zA-Z0-9-]+$

Required: No

LoggingConfiguration

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

Type: LoggingConfiguration object

Required: No

Response Syntax


{
   "FirewallArn": "string",
   "FirewallName": "string",
   "LoggingConfiguration": { 
      "LogDestinationConfigs": [ 
         { 
            "LogDestination": { 
               "string" : "string" 
            },
            "LogDestinationType": "string",
            "LogType": "string"
         }
      ]
   }
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

FirewallArn

The Amazon Resource Name (ARN) of the firewall.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

Pattern: ^arn:aws.*

FirewallName

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: ^[a-zA-Z0-9-]+$

LoggingConfiguration

Defines how AWS Network Firewall performs logging for a Firewall.

Type: LoggingConfiguration object

Errors

For information about the errors that are common to all actions, see Common Errors.

InternalServerError

Your request is valid, but Network Firewall couldn't perform the operation because of a system problem. Retry your request.

HTTP Status Code: 500

InvalidRequestException

The operation failed because of a problem with your request. Examples include:

You specified an unsupported parameter name or value.
You tried to update a property with a value that isn't among the available types.
Your request references an ARN that is malformed, or corresponds to a resource that isn't valid in the context of the request.

HTTP Status Code: 400

InvalidTokenException

The token you provided is stale or isn't valid for the operation.

HTTP Status Code: 400

LogDestinationPermissionException

Unable to send logs to a configured logging destination.

HTTP Status Code: 400

ResourceNotFoundException

Unable to locate a resource using the parameters that you provided.

HTTP Status Code: 400

ThrottlingException

Unable to process the request due to throttling limitations.

HTTP Status Code: 400