FlowLog (AWS Java SDK for Amazon EC2 1.12.591 API)

java.lang.Object
- com.amazonaws.services.ec2.model.FlowLog

All Implemented Interfaces:: Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class FlowLog
extends Object
implements Serializable, Cloneable

Describes a flow log.

See Also:: AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

FlowLog()

Constructors
Constructor and Description
`FlowLog()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`FlowLog`	`clone()`
`boolean`	`equals(Object obj)`
`Date`	`getCreationTime()` The date and time the flow log was created.
`String`	`getDeliverCrossAccountRole()` The ARN of the IAM role that allows the service to publish flow logs across accounts.
`String`	`getDeliverLogsErrorMessage()` Information about the error that occurred.
`String`	`getDeliverLogsPermissionArn()` The ARN of the IAM role allows the service to publish logs to CloudWatch Logs.
`String`	`getDeliverLogsStatus()` The status of the logs delivery (`SUCCESS` \| `FAILED`).
`DestinationOptionsResponse`	`getDestinationOptions()` The destination options.
`String`	`getFlowLogId()` The ID of the flow log.
`String`	`getFlowLogStatus()` The status of the flow log (`ACTIVE`).
`String`	`getLogDestination()` The Amazon Resource Name (ARN) of the destination for the flow log data.
`String`	`getLogDestinationType()` The type of destination for the flow log data.
`String`	`getLogFormat()` The format of the flow log record.
`String`	`getLogGroupName()` The name of the flow log group.
`Integer`	`getMaxAggregationInterval()` The maximum interval of time, in seconds, during which a flow of packets is captured and aggregated into a flow log record.
`String`	`getResourceId()` The ID of the resource being monitored.
`List<Tag>`	`getTags()` The tags for the flow log.
`String`	`getTrafficType()` The type of traffic captured for the flow log.
`int`	`hashCode()`
`void`	`setCreationTime(Date creationTime)` The date and time the flow log was created.
`void`	`setDeliverCrossAccountRole(String deliverCrossAccountRole)` The ARN of the IAM role that allows the service to publish flow logs across accounts.
`void`	`setDeliverLogsErrorMessage(String deliverLogsErrorMessage)` Information about the error that occurred.
`void`	`setDeliverLogsPermissionArn(String deliverLogsPermissionArn)` The ARN of the IAM role allows the service to publish logs to CloudWatch Logs.
`void`	`setDeliverLogsStatus(String deliverLogsStatus)` The status of the logs delivery (`SUCCESS` \| `FAILED`).
`void`	`setDestinationOptions(DestinationOptionsResponse destinationOptions)` The destination options.
`void`	`setFlowLogId(String flowLogId)` The ID of the flow log.
`void`	`setFlowLogStatus(String flowLogStatus)` The status of the flow log (`ACTIVE`).
`void`	`setLogDestination(String logDestination)` The Amazon Resource Name (ARN) of the destination for the flow log data.
`void`	`setLogDestinationType(LogDestinationType logDestinationType)` The type of destination for the flow log data.
`void`	`setLogDestinationType(String logDestinationType)` The type of destination for the flow log data.
`void`	`setLogFormat(String logFormat)` The format of the flow log record.
`void`	`setLogGroupName(String logGroupName)` The name of the flow log group.
`void`	`setMaxAggregationInterval(Integer maxAggregationInterval)` The maximum interval of time, in seconds, during which a flow of packets is captured and aggregated into a flow log record.
`void`	`setResourceId(String resourceId)` The ID of the resource being monitored.
`void`	`setTags(Collection<Tag> tags)` The tags for the flow log.
`void`	`setTrafficType(String trafficType)` The type of traffic captured for the flow log.
`void`	`setTrafficType(TrafficType trafficType)` The type of traffic captured for the flow log.
`String`	`toString()` Returns a string representation of this object.
`FlowLog`	`withCreationTime(Date creationTime)` The date and time the flow log was created.
`FlowLog`	`withDeliverCrossAccountRole(String deliverCrossAccountRole)` The ARN of the IAM role that allows the service to publish flow logs across accounts.
`FlowLog`	`withDeliverLogsErrorMessage(String deliverLogsErrorMessage)` Information about the error that occurred.
`FlowLog`	`withDeliverLogsPermissionArn(String deliverLogsPermissionArn)` The ARN of the IAM role allows the service to publish logs to CloudWatch Logs.
`FlowLog`	`withDeliverLogsStatus(String deliverLogsStatus)` The status of the logs delivery (`SUCCESS` \| `FAILED`).
`FlowLog`	`withDestinationOptions(DestinationOptionsResponse destinationOptions)` The destination options.
`FlowLog`	`withFlowLogId(String flowLogId)` The ID of the flow log.
`FlowLog`	`withFlowLogStatus(String flowLogStatus)` The status of the flow log (`ACTIVE`).
`FlowLog`	`withLogDestination(String logDestination)` The Amazon Resource Name (ARN) of the destination for the flow log data.
`FlowLog`	`withLogDestinationType(LogDestinationType logDestinationType)` The type of destination for the flow log data.
`FlowLog`	`withLogDestinationType(String logDestinationType)` The type of destination for the flow log data.
`FlowLog`	`withLogFormat(String logFormat)` The format of the flow log record.
`FlowLog`	`withLogGroupName(String logGroupName)` The name of the flow log group.
`FlowLog`	`withMaxAggregationInterval(Integer maxAggregationInterval)` The maximum interval of time, in seconds, during which a flow of packets is captured and aggregated into a flow log record.
`FlowLog`	`withResourceId(String resourceId)` The ID of the resource being monitored.
`FlowLog`	`withTags(Collection<Tag> tags)` The tags for the flow log.
`FlowLog`	`withTags(Tag... tags)` The tags for the flow log.
`FlowLog`	`withTrafficType(String trafficType)` The type of traffic captured for the flow log.
`FlowLog`	`withTrafficType(TrafficType trafficType)` The type of traffic captured for the flow log.

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

- Constructor Detail
  - FlowLog
```
public FlowLog()
```
- Method Detail
  - setCreationTime
```
public void setCreationTime(Date creationTime)
```
    The date and time the flow log was created.
    
    Parameters:
    
    creationTime - The date and time the flow log was created.
  - getCreationTime
```
public Date getCreationTime()
```
    The date and time the flow log was created.
    
    Returns:
    
    The date and time the flow log was created.
  - withCreationTime
```
public FlowLog withCreationTime(Date creationTime)
```
    The date and time the flow log was created.
    
    Parameters:
    
    creationTime - The date and time the flow log was created.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDeliverLogsErrorMessage
```
public void setDeliverLogsErrorMessage(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.
    
    Parameters:
    
    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.
  - getDeliverLogsErrorMessage
```
public String getDeliverLogsErrorMessage()
```
    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.
  - withDeliverLogsErrorMessage
```
public FlowLog withDeliverLogsErrorMessage(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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDeliverLogsPermissionArn
```
public void setDeliverLogsPermissionArn(String deliverLogsPermissionArn)
```
    The ARN of the IAM role allows the service to publish logs to CloudWatch Logs.
    
    Parameters:
    
    deliverLogsPermissionArn - The ARN of the IAM role allows the service to publish logs to CloudWatch Logs.
  - getDeliverLogsPermissionArn
```
public String getDeliverLogsPermissionArn()
```
    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.
  - withDeliverLogsPermissionArn
```
public FlowLog withDeliverLogsPermissionArn(String deliverLogsPermissionArn)
```
    The ARN of the IAM role allows the service to publish logs to CloudWatch Logs.
    
    Parameters:
    
    deliverLogsPermissionArn - The ARN of the IAM role allows the service to publish logs to CloudWatch Logs.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDeliverCrossAccountRole
```
public void setDeliverCrossAccountRole(String deliverCrossAccountRole)
```
    The ARN of the IAM role that allows the service to publish flow logs across accounts.
    
    Parameters:
    
    deliverCrossAccountRole - The ARN of the IAM role that allows the service to publish flow logs across accounts.
  - getDeliverCrossAccountRole
```
public String getDeliverCrossAccountRole()
```
    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.
  - withDeliverCrossAccountRole
```
public FlowLog withDeliverCrossAccountRole(String deliverCrossAccountRole)
```
    The ARN of the IAM role that allows the service to publish flow logs across accounts.
    
    Parameters:
    
    deliverCrossAccountRole - The ARN of the IAM role that allows the service to publish flow logs across accounts.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDeliverLogsStatus
```
public void setDeliverLogsStatus(String deliverLogsStatus)
```
    The status of the logs delivery (SUCCESS | FAILED).
    
    Parameters:
    
    deliverLogsStatus - The status of the logs delivery (SUCCESS | FAILED).
  - getDeliverLogsStatus
```
public String getDeliverLogsStatus()
```
    The status of the logs delivery (SUCCESS | FAILED).
    
    Returns:
    
    The status of the logs delivery (SUCCESS | FAILED).
  - withDeliverLogsStatus
```
public FlowLog withDeliverLogsStatus(String deliverLogsStatus)
```
    The status of the logs delivery (SUCCESS | FAILED).
    
    Parameters:
    
    deliverLogsStatus - The status of the logs delivery (SUCCESS | FAILED).
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setFlowLogId
```
public void setFlowLogId(String flowLogId)
```
    The ID of the flow log.
    
    Parameters:
    
    flowLogId - The ID of the flow log.
  - getFlowLogId
```
public String getFlowLogId()
```
    The ID of the flow log.
    
    Returns:
    
    The ID of the flow log.
  - withFlowLogId
```
public FlowLog withFlowLogId(String flowLogId)
```
    The ID of the flow log.
    
    Parameters:
    
    flowLogId - The ID of the flow log.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setFlowLogStatus
```
public void setFlowLogStatus(String flowLogStatus)
```
    The status of the flow log (ACTIVE).
    
    Parameters:
    
    flowLogStatus - The status of the flow log (ACTIVE).
  - getFlowLogStatus
```
public String getFlowLogStatus()
```
    The status of the flow log (ACTIVE).
    
    Returns:
    
    The status of the flow log (ACTIVE).
  - withFlowLogStatus
```
public FlowLog withFlowLogStatus(String flowLogStatus)
```
    The status of the flow log (ACTIVE).
    
    Parameters:
    
    flowLogStatus - The status of the flow log (ACTIVE).
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setLogGroupName
```
public void setLogGroupName(String logGroupName)
```
    The name of the flow log group.
    
    Parameters:
    
    logGroupName - The name of the flow log group.
  - getLogGroupName
```
public String getLogGroupName()
```
    The name of the flow log group.
    
    Returns:
    
    The name of the flow log group.
  - withLogGroupName
```
public FlowLog withLogGroupName(String logGroupName)
```
    The name of the flow log group.
    
    Parameters:
    
    logGroupName - The name of the flow log group.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setResourceId
```
public void setResourceId(String resourceId)
```
    The ID of the resource being monitored.
    
    Parameters:
    
    resourceId - The ID of the resource being monitored.
  - getResourceId
```
public String getResourceId()
```
    The ID of the resource being monitored.
    
    Returns:
    
    The ID of the resource being monitored.
  - withResourceId
```
public FlowLog withResourceId(String resourceId)
```
    The ID of the resource being monitored.
    
    Parameters:
    
    resourceId - The ID of the resource being monitored.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setTrafficType
```
public void setTrafficType(String trafficType)
```
    The type of traffic captured for the flow log.
    
    Parameters:
    
    trafficType - The type of traffic captured for the flow log.
    
    See Also:
    
    TrafficType
  - getTrafficType
```
public String getTrafficType()
```
    The type of traffic captured for the flow log.
    
    Returns:
    
    The type of traffic captured for the flow log.
    
    See Also:
    
    TrafficType
  - withTrafficType
```
public FlowLog withTrafficType(String trafficType)
```
    The type of traffic captured for the flow log.
    
    Parameters:
    
    trafficType - The type of traffic captured for the flow log.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    TrafficType
  - setTrafficType
```
public void setTrafficType(TrafficType trafficType)
```
    The type of traffic captured for the flow log.
    
    Parameters:
    
    trafficType - The type of traffic captured for the flow log.
    
    See Also:
    
    TrafficType
  - withTrafficType
```
public FlowLog withTrafficType(TrafficType trafficType)
```
    The type of traffic captured for the flow log.
    
    Parameters:
    
    trafficType - The type of traffic captured for the flow log.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    TrafficType
  - setLogDestinationType
```
public void setLogDestinationType(String logDestinationType)
```
    The type of destination for the flow log data.
    
    Parameters:
    
    logDestinationType - The type of destination for the flow log data.
    
    See Also:
    
    LogDestinationType
  - getLogDestinationType
```
public String getLogDestinationType()
```
    The type of destination for the flow log data.
    
    Returns:
    
    The type of destination for the flow log data.
    
    See Also:
    
    LogDestinationType
  - withLogDestinationType
```
public FlowLog withLogDestinationType(String logDestinationType)
```
    The type of destination for the flow log data.
    
    Parameters:
    
    logDestinationType - The type of destination for the flow log data.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    LogDestinationType
  - setLogDestinationType
```
public void setLogDestinationType(LogDestinationType logDestinationType)
```
    The type of destination for the flow log data.
    
    Parameters:
    
    logDestinationType - The type of destination for the flow log data.
    
    See Also:
    
    LogDestinationType
  - withLogDestinationType
```
public FlowLog withLogDestinationType(LogDestinationType logDestinationType)
```
    The type of destination for the flow log data.
    
    Parameters:
    
    logDestinationType - The type of destination for the flow log data.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    LogDestinationType
  - setLogDestination
```
public void setLogDestination(String logDestination)
```
    The Amazon Resource Name (ARN) of the destination for the flow log data.
    
    Parameters:
    
    logDestination - The Amazon Resource Name (ARN) of the destination for the flow log data.
  - getLogDestination
```
public String getLogDestination()
```
    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.
  - withLogDestination
```
public FlowLog withLogDestination(String logDestination)
```
    The Amazon Resource Name (ARN) of the destination for the flow log data.
    
    Parameters:
    
    logDestination - The Amazon Resource Name (ARN) of the destination for the flow log data.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setLogFormat
```
public void setLogFormat(String logFormat)
```
    The format of the flow log record.
    
    Parameters:
    
    logFormat - The format of the flow log record.
  - getLogFormat
```
public String getLogFormat()
```
    The format of the flow log record.
    
    Returns:
    
    The format of the flow log record.
  - withLogFormat
```
public FlowLog withLogFormat(String logFormat)
```
    The format of the flow log record.
    
    Parameters:
    
    logFormat - The format of the flow log record.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getTags
```
public List<Tag> getTags()
```
    The tags for the flow log.
    
    Returns:
    
    The tags for the flow log.
  - setTags
```
public void setTags(Collection<Tag> tags)
```
    The tags for the flow log.
    
    Parameters:
    
    tags - The tags for the flow log.
  - withTags
```
public FlowLog withTags(Tag... tags)
```
    The tags for the flow log.
    
    NOTE: This method appends the values to the existing list (if any). Use setTags(java.util.Collection) or withTags(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    tags - The tags for the flow log.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withTags
```
public FlowLog withTags(Collection<Tag> tags)
```
    The tags for the flow log.
    
    Parameters:
    
    tags - The tags for the flow log.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setMaxAggregationInterval
```
public void setMaxAggregationInterval(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
    
    Parameters:
    
    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
  - getMaxAggregationInterval
```
public Integer getMaxAggregationInterval()
```
    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
  - withMaxAggregationInterval
```
public FlowLog withMaxAggregationInterval(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
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDestinationOptions
```
public void setDestinationOptions(DestinationOptionsResponse destinationOptions)
```
    The destination options.
    
    Parameters:
    
    destinationOptions - The destination options.
  - getDestinationOptions
```
public DestinationOptionsResponse getDestinationOptions()
```
    The destination options.
    
    Returns:
    
    The destination options.
  - withDestinationOptions
```
public FlowLog withDestinationOptions(DestinationOptionsResponse destinationOptions)
```
    The destination options.
    
    Parameters:
    
    destinationOptions - The destination options.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - 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
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public FlowLog clone()
```
    Overrides:
    
    clone in class Object

Class FlowLog

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

FlowLog

Method Detail

setCreationTime

getCreationTime

withCreationTime

setDeliverLogsErrorMessage

getDeliverLogsErrorMessage

withDeliverLogsErrorMessage

setDeliverLogsPermissionArn

getDeliverLogsPermissionArn

withDeliverLogsPermissionArn

setDeliverCrossAccountRole

getDeliverCrossAccountRole

withDeliverCrossAccountRole

setDeliverLogsStatus

getDeliverLogsStatus

withDeliverLogsStatus

setFlowLogId

getFlowLogId

withFlowLogId

setFlowLogStatus

getFlowLogStatus

withFlowLogStatus

setLogGroupName

getLogGroupName

withLogGroupName

setResourceId

getResourceId

withResourceId

setTrafficType

getTrafficType

withTrafficType

setTrafficType

withTrafficType

setLogDestinationType

getLogDestinationType

withLogDestinationType

setLogDestinationType

withLogDestinationType

setLogDestination

getLogDestination

withLogDestination

setLogFormat

getLogFormat

withLogFormat

getTags

setTags

withTags

withTags

setMaxAggregationInterval

getMaxAggregationInterval

withMaxAggregationInterval

setDestinationOptions

getDestinationOptions

withDestinationOptions

toString

equals

hashCode

clone