FlowLog (AWS Java SDK :: Services :: Amazon EC2 2.10.13 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`	`deliverLogsErrorMessage()` Information about the error that occurred.
`String`	`deliverLogsPermissionArn()` The ARN of the IAM role that posts logs to CloudWatch Logs.
`String`	`deliverLogsStatus()` The status of the logs delivery (`SUCCESS` \| `FAILED`).
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`String`	`flowLogId()` The flow log ID.
`String`	`flowLogStatus()` The status of the flow log (`ACTIVE`).
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`String`	`logDestination()` Specifies the destination to which the flow log data is published.
`LogDestinationType`	`logDestinationType()` Specifies the type of destination to which the flow log data is published.
`String`	`logDestinationTypeAsString()` Specifies the type of destination to which the flow log data is published.
`String`	`logFormat()` The format of the flow log record.
`String`	`logGroupName()` The name of the flow log group.
`String`	`resourceId()` The ID of the resource on which the flow log was created.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends FlowLog.Builder>`	`serializableBuilderClass()`
`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 Instant creationTime()
```
    The date and time the flow log was created.
    
    Returns:
    
    The date and time the flow log was created.
  - deliverLogsErrorMessage
```
public 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 String deliverLogsPermissionArn()
```
    The ARN of the IAM role that posts logs to CloudWatch Logs.
    
    Returns:
    
    The ARN of the IAM role that posts logs to CloudWatch Logs.
  - deliverLogsStatus
```
public String deliverLogsStatus()
```
    The status of the logs delivery (SUCCESS | FAILED).
    
    Returns:
    
    The status of the logs delivery (SUCCESS | FAILED).
  - flowLogId
```
public String flowLogId()
```
    The flow log ID.
    
    Returns:
    
    The flow log ID.
  - flowLogStatus
```
public String flowLogStatus()
```
    The status of the flow log (ACTIVE).
    
    Returns:
    
    The status of the flow log (ACTIVE).
  - logGroupName
```
public String logGroupName()
```
    The name of the flow log group.
    
    Returns:
    
    The name of the flow log group.
  - resourceId
```
public String resourceId()
```
    The ID of the resource on which the flow log was created.
    
    Returns:
    
    The ID of the resource on which the flow log was created.
  - trafficType
```
public 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 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 LogDestinationType logDestinationType()
```
    Specifies the type of destination to which the flow log data is published. Flow log data can be published to CloudWatch Logs or Amazon S3.
    
    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:
    
    Specifies the type of destination to which the flow log data is published. Flow log data can be published to CloudWatch Logs or Amazon S3.
    
    See Also:
    
    LogDestinationType
  - logDestinationTypeAsString
```
public String logDestinationTypeAsString()
```
    Specifies the type of destination to which the flow log data is published. Flow log data can be published to CloudWatch Logs or Amazon S3.
    
    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:
    
    Specifies the type of destination to which the flow log data is published. Flow log data can be published to CloudWatch Logs or Amazon S3.
    
    See Also:
    
    LogDestinationType
  - logDestination
```
public String logDestination()
```
    Specifies the destination to which the flow log data is published. Flow log data can be published to an CloudWatch Logs log group or an Amazon S3 bucket. If the flow log publishes to CloudWatch Logs, this element indicates the Amazon Resource Name (ARN) of the CloudWatch Logs log group to which the data is published. If the flow log publishes to Amazon S3, this element indicates the ARN of the Amazon S3 bucket to which the data is published.
    
    Returns:
    
    Specifies the destination to which the flow log data is published. Flow log data can be published to an CloudWatch Logs log group or an Amazon S3 bucket. If the flow log publishes to CloudWatch Logs, this element indicates the Amazon Resource Name (ARN) of the CloudWatch Logs log group to which the data is published. If the flow log publishes to Amazon S3, this element indicates the ARN of the Amazon S3 bucket to which the data is published.
  - logFormat
```
public String logFormat()
```
    The format of the flow log record.
    
    Returns:
    
    The format of the flow log record.
  - 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 int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - equalsBySdkFields
```
public boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - 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
  - getValueForField
```
public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)
```
  - sdkFields
```
public 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

deliverLogsStatus

flowLogId

flowLogStatus

logGroupName

resourceId

trafficType

trafficTypeAsString

logDestinationType

logDestinationTypeAsString

logDestination

logFormat

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields