FlowLog (AWS Java SDK :: Services :: Amazon EC2 2.20.151 API)

java.lang.Object
- software.amazon.awssdk.services.ec2.model.FlowLog

All Implemented Interfaces:: Serializable, SdkPojo, ToCopyableBuilder<FlowLog.Builder,FlowLog>

@Generated(value="software.amazon.awssdk:codegen")
public final class FlowLog
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<FlowLog.Builder,FlowLog>

Describes a flow log.

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface FlowLog.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`FlowLog.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static FlowLog.Builder`	`builder()`
`Instant`	`creationTime()` The date and time the flow log was created.
`String`	`deliverCrossAccountRole()` The ARN of the IAM role that allows the service to publish flow logs across accounts.
`String`	`deliverLogsErrorMessage()` Information about the error that occurred.
`String`	`deliverLogsPermissionArn()` The ARN of the IAM role allows the service to publish logs to CloudWatch Logs.
`String`	`deliverLogsStatus()` The status of the logs delivery (`SUCCESS` \| `FAILED`).
`DestinationOptionsResponse`	`destinationOptions()` The destination options.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`String`	`flowLogId()` The ID of the flow log.
`String`	`flowLogStatus()` The status of the flow log (`ACTIVE`).
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`boolean`	`hasTags()` For responses, this returns true if the service returned a value for the Tags property.
`String`	`logDestination()` The Amazon Resource Name (ARN) of the destination for the flow log data.
`LogDestinationType`	`logDestinationType()` The type of destination for the flow log data.
`String`	`logDestinationTypeAsString()` The type of destination for the flow log data.
`String`	`logFormat()` The format of the flow log record.
`String`	`logGroupName()` The name of the flow log group.
`Integer`	`maxAggregationInterval()` The maximum interval of time, in seconds, during which a flow of packets is captured and aggregated into a flow log record.
`String`	`resourceId()` The ID of the resource being monitored.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends FlowLog.Builder>`	`serializableBuilderClass()`
`List<Tag>`	`tags()` The tags for the flow log.
`FlowLog.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.
`TrafficType`	`trafficType()` The type of traffic captured for the flow log.
`String`	`trafficTypeAsString()` The type of traffic captured for the flow log.

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

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - creationTime
```
public final Instant creationTime()
```
    The date and time the flow log was created.
    
    Returns:
    
    The date and time the flow log was created.
  - deliverLogsErrorMessage
```
public final String deliverLogsErrorMessage()
```
    Information about the error that occurred. Rate limited indicates that CloudWatch Logs throttling has been applied for one or more network interfaces, or that you've reached the limit on the number of log groups that you can create. Access error indicates that the IAM role associated with the flow log does not have sufficient permissions to publish to CloudWatch Logs. Unknown error indicates an internal error.
    
    Returns:
    
    Information about the error that occurred. Rate limited indicates that CloudWatch Logs throttling has been applied for one or more network interfaces, or that you've reached the limit on the number of log groups that you can create. Access error indicates that the IAM role associated with the flow log does not have sufficient permissions to publish to CloudWatch Logs. Unknown error indicates an internal error.
  - deliverLogsPermissionArn
```
public final String deliverLogsPermissionArn()
```
    The ARN of the IAM role allows the service to publish logs to CloudWatch Logs.
    
    Returns:
    
    The ARN of the IAM role allows the service to publish logs to CloudWatch Logs.
  - deliverCrossAccountRole
```
public final String deliverCrossAccountRole()
```
    The ARN of the IAM role that allows the service to publish flow logs across accounts.
    
    Returns:
    
    The ARN of the IAM role that allows the service to publish flow logs across accounts.
  - deliverLogsStatus
```
public final String deliverLogsStatus()
```
    The status of the logs delivery (SUCCESS | FAILED).
    
    Returns:
    
    The status of the logs delivery (SUCCESS | FAILED).
  - flowLogId
```
public final String flowLogId()
```
    The ID of the flow log.
    
    Returns:
    
    The ID of the flow log.
  - flowLogStatus
```
public final String flowLogStatus()
```
    The status of the flow log (ACTIVE).
    
    Returns:
    
    The status of the flow log (ACTIVE).
  - logGroupName
```
public final String logGroupName()
```
    The name of the flow log group.
    
    Returns:
    
    The name of the flow log group.
  - resourceId
```
public final String resourceId()
```
    The ID of the resource being monitored.
    
    Returns:
    
    The ID of the resource being monitored.
  - trafficType
```
public final TrafficType trafficType()
```
    The type of traffic captured for the flow log.
    
    If the service returns an enum value that is not available in the current SDK version, trafficType will return TrafficType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from trafficTypeAsString().
    
    Returns:
    
    The type of traffic captured for the flow log.
    
    See Also:
    
    TrafficType
  - trafficTypeAsString
```
public final String trafficTypeAsString()
```
    The type of traffic captured for the flow log.
    
    If the service returns an enum value that is not available in the current SDK version, trafficType will return TrafficType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from trafficTypeAsString().
    
    Returns:
    
    The type of traffic captured for the flow log.
    
    See Also:
    
    TrafficType
  - logDestinationType
```
public final LogDestinationType logDestinationType()
```
    The type of destination for the flow log data.
    
    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 destination for the flow log data.
    
    See Also:
    
    LogDestinationType
  - logDestinationTypeAsString
```
public final String logDestinationTypeAsString()
```
    The type of destination for the flow log data.
    
    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 destination for the flow log data.
    
    See Also:
    
    LogDestinationType
  - logDestination
```
public final String logDestination()
```
    The Amazon Resource Name (ARN) of the destination for the flow log data.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the destination for the flow log data.
  - logFormat
```
public final String logFormat()
```
    The format of the flow log record.
    
    Returns:
    
    The format of the flow log record.
  - hasTags
```
public final boolean hasTags()
```
    For responses, this returns true if the service returned a value for the Tags 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.
  - tags
```
public final List<Tag> tags()
```
    The tags for the flow log.
    
    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 hasTags() method.
    
    Returns:
    
    The tags for the flow log.
  - maxAggregationInterval
```
public final Integer maxAggregationInterval()
```
    The maximum interval of time, in seconds, during which a flow of packets is captured and aggregated into a flow log record.
    
    When a network interface is attached to a Nitro-based instance, the aggregation interval is always 60 seconds (1 minute) or less, regardless of the specified value.
    
    Valid Values: 60 | 600
    
    Returns:
    
    The maximum interval of time, in seconds, during which a flow of packets is captured and aggregated into a flow log record.
    
    When a network interface is attached to a Nitro-based instance, the aggregation interval is always 60 seconds (1 minute) or less, regardless of the specified value.
    
    Valid Values: 60 | 600
  - destinationOptions
```
public final DestinationOptionsResponse destinationOptions()
```
    The destination options.
    
    Returns:
    
    The destination options.
  - toBuilder
```
public FlowLog.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<FlowLog.Builder,FlowLog>
  - builder
```
public static FlowLog.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends FlowLog.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - equalsBySdkFields
```
public final boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - 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)
```
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class FlowLog

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

creationTime

deliverLogsErrorMessage

deliverLogsPermissionArn

deliverCrossAccountRole

deliverLogsStatus

flowLogId

flowLogStatus

logGroupName

resourceId

trafficType

trafficTypeAsString

logDestinationType

logDestinationTypeAsString

logDestination

logFormat

hasTags

tags

maxAggregationInterval

destinationOptions

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields