software.amazon.awssdk.services.ec2.model

Class FlowLog

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

Method Summary

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()
boolean	hasTags() Returns true if the Tags property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
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.
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 on which the flow log was created.
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 that posts logs to CloudWatch Logs.

Returns:

The ARN of the IAM role that posts logs to CloudWatch Logs.

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 flow log ID.

Returns:

The flow log ID.

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 on which the flow log was created.

Returns:

The ID of the resource on which the flow log was created.

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()

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 final 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 final 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 final String logFormat()

The format of the flow log record.

Returns:

The format of the flow log record.

hasTags

public final boolean hasTags()

Returns true if the Tags property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

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.

You can use hasTags() to see if a value was sent in this field.

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

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