software.amazon.awssdk.services.ec2.model

Interface FlowLog.Builder

All Superinterfaces:

Buildable, CopyableBuilder<FlowLog.Builder,FlowLog>, SdkBuilder<FlowLog.Builder,FlowLog>, SdkPojo

Enclosing class:

FlowLog

public static interface FlowLog.Builder
extends SdkPojo, CopyableBuilder<FlowLog.Builder,FlowLog>

Method Summary

Modifier and Type	Method and Description
FlowLog.Builder	creationTime(Instant creationTime) The date and time the flow log was created.
FlowLog.Builder	deliverCrossAccountRole(String deliverCrossAccountRole) The ARN of the IAM role that allows the service to publish flow logs across accounts.
FlowLog.Builder	deliverLogsErrorMessage(String deliverLogsErrorMessage) Information about the error that occurred.
FlowLog.Builder	deliverLogsPermissionArn(String deliverLogsPermissionArn) The ARN of the IAM role allows the service to publish logs to CloudWatch Logs.
FlowLog.Builder	deliverLogsStatus(String deliverLogsStatus) The status of the logs delivery (SUCCESS | FAILED).
default FlowLog.Builder	destinationOptions(Consumer<DestinationOptionsResponse.Builder> destinationOptions) The destination options.
FlowLog.Builder	destinationOptions(DestinationOptionsResponse destinationOptions) The destination options.
FlowLog.Builder	flowLogId(String flowLogId) The ID of the flow log.
FlowLog.Builder	flowLogStatus(String flowLogStatus) The status of the flow log (ACTIVE).
FlowLog.Builder	logDestination(String logDestination) The Amazon Resource Name (ARN) of the destination for the flow log data.
FlowLog.Builder	logDestinationType(LogDestinationType logDestinationType) The type of destination for the flow log data.
FlowLog.Builder	logDestinationType(String logDestinationType) The type of destination for the flow log data.
FlowLog.Builder	logFormat(String logFormat) The format of the flow log record.
FlowLog.Builder	logGroupName(String logGroupName) The name of the flow log group.
FlowLog.Builder	maxAggregationInterval(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.Builder	resourceId(String resourceId) The ID of the resource being monitored.
FlowLog.Builder	tags(Collection<Tag> tags) The tags for the flow log.
FlowLog.Builder	tags(Consumer<Tag.Builder>... tags) The tags for the flow log.
FlowLog.Builder	tags(Tag... tags) The tags for the flow log.
FlowLog.Builder	trafficType(String trafficType) The type of traffic captured for the flow log.
FlowLog.Builder	trafficType(TrafficType trafficType) The type of traffic captured for the flow log.

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Method Detail

creationTime

FlowLog.Builder creationTime(Instant 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.

deliverLogsErrorMessage

FlowLog.Builder deliverLogsErrorMessage(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.

deliverLogsPermissionArn

FlowLog.Builder deliverLogsPermissionArn(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.

deliverCrossAccountRole

FlowLog.Builder deliverCrossAccountRole(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.

deliverLogsStatus

FlowLog.Builder deliverLogsStatus(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.

flowLogId

FlowLog.Builder flowLogId(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.

flowLogStatus

FlowLog.Builder flowLogStatus(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.

logGroupName

FlowLog.Builder logGroupName(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.

resourceId

FlowLog.Builder resourceId(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.

trafficType

FlowLog.Builder trafficType(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, TrafficType

trafficType

FlowLog.Builder trafficType(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, TrafficType

logDestinationType

FlowLog.Builder logDestinationType(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, LogDestinationType

logDestinationType

FlowLog.Builder logDestinationType(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, LogDestinationType

logDestination

FlowLog.Builder logDestination(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.

logFormat

FlowLog.Builder logFormat(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.

tags

FlowLog.Builder tags(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.

tags

FlowLog.Builder tags(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.

tags

FlowLog.Builder tags(Consumer<Tag.Builder>... tags)

The tags for the flow log.

This is a convenience method that creates an instance of the Tag.Builder avoiding the need to create one manually via Tag.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #tags(List).

Parameters:

tags - a consumer that will call methods on Tag.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

#tags(java.util.Collection)

maxAggregationInterval

FlowLog.Builder maxAggregationInterval(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.

destinationOptions

FlowLog.Builder destinationOptions(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.

destinationOptions

default FlowLog.Builder destinationOptions(Consumer<DestinationOptionsResponse.Builder> destinationOptions)

The destination options.

This is a convenience method that creates an instance of the DestinationOptionsResponse.Builder avoiding the need to create one manually via DestinationOptionsResponse.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to destinationOptions(DestinationOptionsResponse).

Parameters:

destinationOptions - a consumer that will call methods on DestinationOptionsResponse.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

destinationOptions(DestinationOptionsResponse)