LogDestinationConfig (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.networkfirewall.model.LogDestinationConfig

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class LogDestinationConfig
extends Object
implements Serializable, Cloneable, StructuredPojo
```
Defines where AWS Network Firewall sends logs for the firewall for one log type. This is used in LoggingConfiguration. You can send each type of log to an Amazon S3 bucket, a CloudWatch log group, or a Kinesis Data Firehose delivery stream.

Network Firewall generates logs for stateful rule groups. You can save alert and flow log types. The stateful rules engine records flow logs for all network traffic that it receives. It records alert logs for traffic that matches stateful rules that have the rule action set to DROP or ALERT.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

LogDestinationConfig()

Constructors
Constructor and Description
`LogDestinationConfig()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`LogDestinationConfig`	`addLogDestinationEntry(String key, String value)` Add a single LogDestination entry
`LogDestinationConfig`	`clearLogDestinationEntries()` Removes all the entries added into LogDestination.
`LogDestinationConfig`	`clone()`
`boolean`	`equals(Object obj)`
`Map<String,String>`	`getLogDestination()` The named location for the logs, provided in a key:value mapping that is specific to the chosen destination type.
`String`	`getLogDestinationType()` The type of storage destination to send these logs to.
`String`	`getLogType()` The type of log to send.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setLogDestination(Map<String,String> logDestination)` The named location for the logs, provided in a key:value mapping that is specific to the chosen destination type.
`void`	`setLogDestinationType(String logDestinationType)` The type of storage destination to send these logs to.
`void`	`setLogType(String logType)` The type of log to send.
`String`	`toString()` Returns a string representation of this object.
`LogDestinationConfig`	`withLogDestination(Map<String,String> logDestination)` The named location for the logs, provided in a key:value mapping that is specific to the chosen destination type.
`LogDestinationConfig`	`withLogDestinationType(LogDestinationType logDestinationType)` The type of storage destination to send these logs to.
`LogDestinationConfig`	`withLogDestinationType(String logDestinationType)` The type of storage destination to send these logs to.
`LogDestinationConfig`	`withLogType(LogType logType)` The type of log to send.
`LogDestinationConfig`	`withLogType(String logType)` The type of log to send.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - LogDestinationConfig
```
public LogDestinationConfig()
```
- Method Detail
  - setLogType
```
public void setLogType(String logType)
```
    The type of log to send. Alert logs report traffic that matches a StatefulRule with an action setting that sends an alert log message. Flow logs are standard network traffic flow logs.
    
    Parameters:
    
    logType - The type of log to send. Alert logs report traffic that matches a StatefulRule with an action setting that sends an alert log message. Flow logs are standard network traffic flow logs.
    
    See Also:
    
    LogType
  - getLogType
```
public String getLogType()
```
    The type of log to send. Alert logs report traffic that matches a StatefulRule with an action setting that sends an alert log message. Flow logs are standard network traffic flow logs.
    
    Returns:
    
    The type of log to send. Alert logs report traffic that matches a StatefulRule with an action setting that sends an alert log message. Flow logs are standard network traffic flow logs.
    
    See Also:
    
    LogType
  - withLogType
```
public LogDestinationConfig withLogType(String logType)
```
    The type of log to send. Alert logs report traffic that matches a StatefulRule with an action setting that sends an alert log message. Flow logs are standard network traffic flow logs.
    
    Parameters:
    
    logType - The type of log to send. Alert logs report traffic that matches a StatefulRule with an action setting that sends an alert log message. Flow logs are standard network traffic flow logs.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    LogType
  - withLogType
```
public LogDestinationConfig withLogType(LogType logType)
```
    The type of log to send. Alert logs report traffic that matches a StatefulRule with an action setting that sends an alert log message. Flow logs are standard network traffic flow logs.
    
    Parameters:
    
    logType - The type of log to send. Alert logs report traffic that matches a StatefulRule with an action setting that sends an alert log message. Flow logs are standard network traffic flow logs.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    LogType
  - setLogDestinationType
```
public void setLogDestinationType(String 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 Kinesis Data Firehose delivery stream.
    
    Parameters:
    
    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 Kinesis Data Firehose delivery stream.
    
    See Also:
    
    LogDestinationType
  - getLogDestinationType
```
public String getLogDestinationType()
```
    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 Kinesis Data Firehose delivery stream.
    
    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 Kinesis Data Firehose delivery stream.
    
    See Also:
    
    LogDestinationType
  - withLogDestinationType
```
public LogDestinationConfig withLogDestinationType(String 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 Kinesis Data Firehose delivery stream.
    
    Parameters:
    
    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 Kinesis Data Firehose delivery stream.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    LogDestinationType
  - withLogDestinationType
```
public LogDestinationConfig withLogDestinationType(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 Kinesis Data Firehose delivery stream.
    
    Parameters:
    
    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 Kinesis Data Firehose delivery stream.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    LogDestinationType
  - getLogDestination
```
public Map<String,String> getLogDestination()
```
    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 Kinesis Data 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" }
    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 Kinesis Data 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" }
  - setLogDestination
```
public void setLogDestination(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 Kinesis Data 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" }
    Parameters:
    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 Kinesis Data 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" }
  - withLogDestination
```
public LogDestinationConfig withLogDestination(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 Kinesis Data 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" }
    Parameters:
    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 Kinesis Data 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" }
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - addLogDestinationEntry
```
public LogDestinationConfig addLogDestinationEntry(String key,
                                                   String value)
```
    Add a single LogDestination entry
    
    See Also:
    
    withLogDestination(java.util.Map<java.lang.String, java.lang.String>)
  - clearLogDestinationEntries
```
public LogDestinationConfig clearLogDestinationEntries()
```
    Removes all the entries added into LogDestination.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public 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
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public LogDestinationConfig clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

Did this page help you?

Class LogDestinationConfig

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

LogDestinationConfig

Method Detail

setLogType

getLogType

withLogType

withLogType

setLogDestinationType

getLogDestinationType

withLogDestinationType

withLogDestinationType

getLogDestination

setLogDestination

withLogDestination

addLogDestinationEntry

clearLogDestinationEntries

toString

equals

hashCode

clone

marshall