Class FlowLog

java.lang.Object
software.amazon.awssdk.services.ec2.model.FlowLog
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<FlowLog.Builder,FlowLog>
@Generated("software.amazon.awssdk:codegen") public final class FlowLog extends Object implements SdkPojo, Serializable, ToCopyableBuilder<FlowLog.Builder,FlowLog>

Describes a flow log.

See Also:

  • Method Details

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

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

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

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

    • 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()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<FlowLog.Builder,FlowLog>
      Returns:
      a builder for type T

    • 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)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.