Package software.amazon.awssdk.services.networkfirewall.model

Class LogDestinationConfig

    • Method Detail

      • logType

        public final LogType logType()

        The type of log to record. You can record the following types of logs from your Network Firewall stateful engine.

        • ALERT - Logs for traffic that matches your stateful rules and that have an action that sends an alert. A stateful rule sends alerts for the rule actions DROP, ALERT, and REJECT. For more information, see StatefulRule.

        • FLOW - Standard network traffic flow logs. The stateful rules engine records flow logs for all network traffic that it receives. Each flow log record captures the network flow for a specific standard stateless rule group.

        • TLS - Logs for events that are related to TLS inspection. For more information, see Inspecting SSL/TLS traffic with TLS inspection configurations in the Network Firewall Developer Guide.

        If the service returns an enum value that is not available in the current SDK version, logType will return LogType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from logTypeAsString().

        Returns:
        The type of log to record. You can record the following types of logs from your Network Firewall stateful engine.

        • ALERT - Logs for traffic that matches your stateful rules and that have an action that sends an alert. A stateful rule sends alerts for the rule actions DROP, ALERT, and REJECT. For more information, see StatefulRule.

        • FLOW - Standard network traffic flow logs. The stateful rules engine records flow logs for all network traffic that it receives. Each flow log record captures the network flow for a specific standard stateless rule group.

        • TLS - Logs for events that are related to TLS inspection. For more information, see Inspecting SSL/TLS traffic with TLS inspection configurations in the Network Firewall Developer Guide.

        See Also:
        LogType

      • logTypeAsString

        public final String logTypeAsString()

        The type of log to record. You can record the following types of logs from your Network Firewall stateful engine.

        • ALERT - Logs for traffic that matches your stateful rules and that have an action that sends an alert. A stateful rule sends alerts for the rule actions DROP, ALERT, and REJECT. For more information, see StatefulRule.

        • FLOW - Standard network traffic flow logs. The stateful rules engine records flow logs for all network traffic that it receives. Each flow log record captures the network flow for a specific standard stateless rule group.

        • TLS - Logs for events that are related to TLS inspection. For more information, see Inspecting SSL/TLS traffic with TLS inspection configurations in the Network Firewall Developer Guide.

        If the service returns an enum value that is not available in the current SDK version, logType will return LogType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from logTypeAsString().

        Returns:
        The type of log to record. You can record the following types of logs from your Network Firewall stateful engine.

        • ALERT - Logs for traffic that matches your stateful rules and that have an action that sends an alert. A stateful rule sends alerts for the rule actions DROP, ALERT, and REJECT. For more information, see StatefulRule.

        • FLOW - Standard network traffic flow logs. The stateful rules engine records flow logs for all network traffic that it receives. Each flow log record captures the network flow for a specific standard stateless rule group.

        • TLS - Logs for events that are related to TLS inspection. For more information, see Inspecting SSL/TLS traffic with TLS inspection configurations in the Network Firewall Developer Guide.

        See Also:
        LogType

      • logDestinationType

        public final LogDestinationType logDestinationType()

        The type of storage destination to send these logs to. You can send logs to an Amazon S3 bucket, a CloudWatch log group, or a Firehose delivery stream.

        If the service returns an enum value that is not available in the current SDK version, logDestinationType will return LogDestinationType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from logDestinationTypeAsString().

        Returns:
        The type of storage destination to send these logs to. You can send logs to an Amazon S3 bucket, a CloudWatch log group, or a Firehose delivery stream.
        See Also:
        LogDestinationType

      • logDestinationTypeAsString

        public final String logDestinationTypeAsString()

        The type of storage destination to send these logs to. You can send logs to an Amazon S3 bucket, a CloudWatch log group, or a Firehose delivery stream.

        If the service returns an enum value that is not available in the current SDK version, logDestinationType will return LogDestinationType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from logDestinationTypeAsString().

        Returns:
        The type of storage destination to send these logs to. You can send logs to an Amazon S3 bucket, a CloudWatch log group, or a Firehose delivery stream.
        See Also:
        LogDestinationType

      • hasLogDestination

        public final boolean hasLogDestination()
        For responses, this returns true if the service returned a value for the LogDestination property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

      • logDestination

        public final Map<String,​String> logDestination()

        The named location for the logs, provided in a key:value mapping that is specific to the chosen destination type.

        • For an Amazon S3 bucket, provide the name of the bucket, with key bucketName, and optionally provide a prefix, with key prefix.

          The following example specifies an Amazon S3 bucket named DOC-EXAMPLE-BUCKET and the prefix alerts:

          "LogDestination": { "bucketName": "DOC-EXAMPLE-BUCKET", "prefix": "alerts" }

        • For a CloudWatch log group, provide the name of the CloudWatch log group, with key logGroup. The following example specifies a log group named alert-log-group:

          "LogDestination": { "logGroup": "alert-log-group" }

        • For a Firehose delivery stream, provide the name of the delivery stream, with key deliveryStream. The following example specifies a delivery stream named alert-delivery-stream:

          "LogDestination": { "deliveryStream": "alert-delivery-stream" }

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasLogDestination() method.

        Returns:
        The named location for the logs, provided in a key:value mapping that is specific to the chosen destination type.

        • For an Amazon S3 bucket, provide the name of the bucket, with key bucketName, and optionally provide a prefix, with key prefix.

          The following example specifies an Amazon S3 bucket named DOC-EXAMPLE-BUCKET and the prefix alerts:

          "LogDestination": { "bucketName": "DOC-EXAMPLE-BUCKET", "prefix": "alerts" }

        • For a CloudWatch log group, provide the name of the CloudWatch log group, with key logGroup. The following example specifies a log group named alert-log-group:

          "LogDestination": { "logGroup": "alert-log-group" }

        • For a Firehose delivery stream, provide the name of the delivery stream, with key deliveryStream. The following example specifies a delivery stream named alert-delivery-stream:

          "LogDestination": { "deliveryStream": "alert-delivery-stream" }

      • hashCode

        public final int hashCode()
        Overrides:
        hashCode in class Object

      • equals

        public final boolean equals​(Object obj)
        Overrides:
        equals in class Object

      • toString

        public final String toString()
        Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
        Overrides:
        toString in class Object

      • getValueForField

        public final <T> Optional<T> getValueForField​(String fieldName,
                                              Class<T> clazz)