Class FlowLog
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<FlowLog.Builder,
FlowLog>
Describes a flow log.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic FlowLog.Builder
builder()
final Instant
The date and time the flow log was created.final String
The ARN of the IAM role that allows the service to publish flow logs across accounts.final String
Information about the error that occurred.final String
The ARN of the IAM role allows the service to publish logs to CloudWatch Logs.final String
The status of the logs delivery (SUCCESS
|FAILED
).The destination options.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final String
The ID of the flow log.final String
The status of the flow log (ACTIVE
).final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
final boolean
hasTags()
For responses, this returns true if the service returned a value for the Tags property.final String
The Amazon Resource Name (ARN) of the destination for the flow log data.final LogDestinationType
The type of destination for the flow log data.final String
The type of destination for the flow log data.final String
The format of the flow log record.final String
The name of the flow log group.final Integer
The maximum interval of time, in seconds, during which a flow of packets is captured and aggregated into a flow log record.final String
The ID of the resource being monitored.static Class
<? extends FlowLog.Builder> tags()
The tags for the flow log.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.final TrafficType
The type of traffic captured for the flow log.final String
The type of traffic captured for the flow log.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
creationTime
The date and time the flow log was created.
- Returns:
- The date and time the flow log was created.
-
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
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
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
The status of the logs delivery (
SUCCESS
|FAILED
).- Returns:
- The status of the logs delivery (
SUCCESS
|FAILED
).
-
flowLogId
The ID of the flow log.
- Returns:
- The ID of the flow log.
-
flowLogStatus
The status of the flow log (
ACTIVE
).- Returns:
- The status of the flow log (
ACTIVE
).
-
logGroupName
The name of the flow log group.
- Returns:
- The name of the flow log group.
-
resourceId
The ID of the resource being monitored.
- Returns:
- The ID of the resource being monitored.
-
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 returnTrafficType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromtrafficTypeAsString()
.- Returns:
- The type of traffic captured for the flow log.
- See Also:
-
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 returnTrafficType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromtrafficTypeAsString()
.- Returns:
- The type of traffic captured for the flow log.
- See Also:
-
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 returnLogDestinationType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromlogDestinationTypeAsString()
.- Returns:
- The type of destination for the flow log data.
- See Also:
-
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 returnLogDestinationType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromlogDestinationTypeAsString()
.- Returns:
- The type of destination for the flow log data.
- See Also:
-
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
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 theisEmpty()
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
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
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
The destination options.
- Returns:
- The destination options.
-
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 interfaceToCopyableBuilder<FlowLog.Builder,
FlowLog> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-