software.amazon.awssdk.services.ec2.model

Interface CreateFlowLogsRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<CreateFlowLogsRequest.Builder,CreateFlowLogsRequest>, Ec2Request.Builder, SdkBuilder<CreateFlowLogsRequest.Builder,CreateFlowLogsRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

CreateFlowLogsRequest

public static interface CreateFlowLogsRequest.Builder
extends Ec2Request.Builder, SdkPojo, CopyableBuilder<CreateFlowLogsRequest.Builder,CreateFlowLogsRequest>

Method Summary

Modifier and Type	Method and Description
CreateFlowLogsRequest.Builder	clientToken(String clientToken) Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
CreateFlowLogsRequest.Builder	deliverCrossAccountRole(String deliverCrossAccountRole) The ARN of the IAM role that allows Amazon EC2 to publish flow logs across accounts.
CreateFlowLogsRequest.Builder	deliverLogsPermissionArn(String deliverLogsPermissionArn) The ARN of the IAM role that allows Amazon EC2 to publish flow logs to a CloudWatch Logs log group in your account.
default CreateFlowLogsRequest.Builder	destinationOptions(Consumer<DestinationOptionsRequest.Builder> destinationOptions) The destination options.
CreateFlowLogsRequest.Builder	destinationOptions(DestinationOptionsRequest destinationOptions) The destination options.
CreateFlowLogsRequest.Builder	logDestination(String logDestination) The destination for the flow log data.
CreateFlowLogsRequest.Builder	logDestinationType(LogDestinationType logDestinationType) The type of destination for the flow log data.
CreateFlowLogsRequest.Builder	logDestinationType(String logDestinationType) The type of destination for the flow log data.
CreateFlowLogsRequest.Builder	logFormat(String logFormat) The fields to include in the flow log record.
CreateFlowLogsRequest.Builder	logGroupName(String logGroupName) The name of a new or existing CloudWatch Logs log group where Amazon EC2 publishes your flow logs.
CreateFlowLogsRequest.Builder	maxAggregationInterval(Integer maxAggregationInterval) The maximum interval of time during which a flow of packets is captured and aggregated into a flow log record.
CreateFlowLogsRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
CreateFlowLogsRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
CreateFlowLogsRequest.Builder	resourceIds(Collection<String> resourceIds) The IDs of the resources to monitor.
CreateFlowLogsRequest.Builder	resourceIds(String... resourceIds) The IDs of the resources to monitor.
CreateFlowLogsRequest.Builder	resourceType(FlowLogsResourceType resourceType) The type of resource to monitor.
CreateFlowLogsRequest.Builder	resourceType(String resourceType) The type of resource to monitor.
CreateFlowLogsRequest.Builder	tagSpecifications(Collection<TagSpecification> tagSpecifications) The tags to apply to the flow logs.
CreateFlowLogsRequest.Builder	tagSpecifications(Consumer<TagSpecification.Builder>... tagSpecifications) The tags to apply to the flow logs.
CreateFlowLogsRequest.Builder	tagSpecifications(TagSpecification... tagSpecifications) The tags to apply to the flow logs.
CreateFlowLogsRequest.Builder	trafficType(String trafficType) The type of traffic to monitor (accepted traffic, rejected traffic, or all traffic).
CreateFlowLogsRequest.Builder	trafficType(TrafficType trafficType) The type of traffic to monitor (accepted traffic, rejected traffic, or all traffic).

Methods inherited from interface software.amazon.awssdk.services.ec2.model.Ec2Request.Builder

build

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

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

clientToken

CreateFlowLogsRequest.Builder clientToken(String clientToken)

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.

Parameters:

clientToken - Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.

Returns:

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

deliverLogsPermissionArn

CreateFlowLogsRequest.Builder deliverLogsPermissionArn(String deliverLogsPermissionArn)

The ARN of the IAM role that allows Amazon EC2 to publish flow logs to a CloudWatch Logs log group in your account.

This parameter is required if the destination type is cloud-watch-logs and unsupported otherwise.

Parameters:

deliverLogsPermissionArn - The ARN of the IAM role that allows Amazon EC2 to publish flow logs to a CloudWatch Logs log group in your account.

This parameter is required if the destination type is cloud-watch-logs and unsupported otherwise.

Returns:

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

deliverCrossAccountRole

CreateFlowLogsRequest.Builder deliverCrossAccountRole(String deliverCrossAccountRole)

The ARN of the IAM role that allows Amazon EC2 to publish flow logs across accounts.

Parameters:

deliverCrossAccountRole - The ARN of the IAM role that allows Amazon EC2 to publish flow logs across accounts.

Returns:

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

logGroupName

CreateFlowLogsRequest.Builder logGroupName(String logGroupName)

The name of a new or existing CloudWatch Logs log group where Amazon EC2 publishes your flow logs.

This parameter is valid only if the destination type is cloud-watch-logs.

Parameters:

logGroupName - The name of a new or existing CloudWatch Logs log group where Amazon EC2 publishes your flow logs.

This parameter is valid only if the destination type is cloud-watch-logs.

Returns:

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

resourceIds

CreateFlowLogsRequest.Builder resourceIds(Collection<String> resourceIds)

The IDs of the resources to monitor. For example, if the resource type is VPC, specify the IDs of the VPCs.

Constraints: Maximum of 25 for transit gateway resource types. Maximum of 1000 for the other resource types.

Parameters:

resourceIds - The IDs of the resources to monitor. For example, if the resource type is VPC, specify the IDs of the VPCs.

Constraints: Maximum of 25 for transit gateway resource types. Maximum of 1000 for the other resource types.

Returns:

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

resourceIds

CreateFlowLogsRequest.Builder resourceIds(String... resourceIds)

The IDs of the resources to monitor. For example, if the resource type is VPC, specify the IDs of the VPCs.

Constraints: Maximum of 25 for transit gateway resource types. Maximum of 1000 for the other resource types.

Parameters:

resourceIds - The IDs of the resources to monitor. For example, if the resource type is VPC, specify the IDs of the VPCs.

Constraints: Maximum of 25 for transit gateway resource types. Maximum of 1000 for the other resource types.

Returns:

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

resourceType

CreateFlowLogsRequest.Builder resourceType(String resourceType)

The type of resource to monitor.

Parameters:

resourceType - The type of resource to monitor.

Returns:

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

See Also:

FlowLogsResourceType, FlowLogsResourceType

resourceType

CreateFlowLogsRequest.Builder resourceType(FlowLogsResourceType resourceType)

The type of resource to monitor.

Parameters:

resourceType - The type of resource to monitor.

Returns:

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

See Also:

FlowLogsResourceType, FlowLogsResourceType

trafficType

CreateFlowLogsRequest.Builder trafficType(String trafficType)

The type of traffic to monitor (accepted traffic, rejected traffic, or all traffic). This parameter is not supported for transit gateway resource types. It is required for the other resource types.

Parameters:

trafficType - The type of traffic to monitor (accepted traffic, rejected traffic, or all traffic). This parameter is not supported for transit gateway resource types. It is required for the other resource types.

Returns:

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

See Also:

TrafficType, TrafficType

trafficType

CreateFlowLogsRequest.Builder trafficType(TrafficType trafficType)

The type of traffic to monitor (accepted traffic, rejected traffic, or all traffic). This parameter is not supported for transit gateway resource types. It is required for the other resource types.

Parameters:

trafficType - The type of traffic to monitor (accepted traffic, rejected traffic, or all traffic). This parameter is not supported for transit gateway resource types. It is required for the other resource types.

Returns:

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

See Also:

TrafficType, TrafficType

logDestinationType

CreateFlowLogsRequest.Builder logDestinationType(String logDestinationType)

The type of destination for the flow log data.

Default: cloud-watch-logs

Parameters:

logDestinationType - The type of destination for the flow log data.

Default: cloud-watch-logs

Returns:

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

See Also:

LogDestinationType, LogDestinationType

logDestinationType

CreateFlowLogsRequest.Builder logDestinationType(LogDestinationType logDestinationType)

The type of destination for the flow log data.

Default: cloud-watch-logs

Parameters:

logDestinationType - The type of destination for the flow log data.

Default: cloud-watch-logs

Returns:

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

See Also:

LogDestinationType, LogDestinationType

logDestination

CreateFlowLogsRequest.Builder logDestination(String logDestination)

The destination for the flow log data. The meaning of this parameter depends on the destination type.

• If the destination type is cloud-watch-logs, specify the ARN of a CloudWatch Logs log group. For example:

  arn:aws:logs:region:account_id:log-group:my_group

  Alternatively, use the LogGroupName parameter.

• If the destination type is s3, specify the ARN of an S3 bucket. For example:

  arn:aws:s3:::my_bucket/my_subfolder/

  The subfolder is optional. Note that you can't use AWSLogs as a subfolder name.

• If the destination type is kinesis-data-firehose, specify the ARN of a Kinesis Data Firehose delivery stream. For example:

  arn:aws:firehose:region:account_id:deliverystream:my_stream

Parameters:

logDestination - The destination for the flow log data. The meaning of this parameter depends on the destination type.

• If the destination type is cloud-watch-logs, specify the ARN of a CloudWatch Logs log group. For example:

  arn:aws:logs:region:account_id:log-group:my_group

  Alternatively, use the LogGroupName parameter.

• If the destination type is s3, specify the ARN of an S3 bucket. For example:

  arn:aws:s3:::my_bucket/my_subfolder/

  The subfolder is optional. Note that you can't use AWSLogs as a subfolder name.

• If the destination type is kinesis-data-firehose, specify the ARN of a Kinesis Data Firehose delivery stream. For example:

  arn:aws:firehose:region:account_id:deliverystream:my_stream

Returns:

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

logFormat

CreateFlowLogsRequest.Builder logFormat(String logFormat)

The fields to include in the flow log record. List the fields in the order in which they should appear. If you omit this parameter, the flow log is created using the default format. If you specify this parameter, you must include at least one field. For more information about the available fields, see Flow log records in the Amazon VPC User Guide or Transit Gateway Flow Log records in the Amazon Web Services Transit Gateway Guide.

Specify the fields using the ${field-id} format, separated by spaces. For the CLI, surround this parameter value with single quotes on Linux or double quotes on Windows.

Parameters:

logFormat - The fields to include in the flow log record. List the fields in the order in which they should appear. If you omit this parameter, the flow log is created using the default format. If you specify this parameter, you must include at least one field. For more information about the available fields, see Flow log records in the Amazon VPC User Guide or Transit Gateway Flow Log records in the Amazon Web Services Transit Gateway Guide.

Specify the fields using the ${field-id} format, separated by spaces. For the CLI, surround this parameter value with single quotes on Linux or double quotes on Windows.

Returns:

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

tagSpecifications

CreateFlowLogsRequest.Builder tagSpecifications(Collection<TagSpecification> tagSpecifications)

The tags to apply to the flow logs.

Parameters:

tagSpecifications - The tags to apply to the flow logs.

Returns:

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

tagSpecifications

CreateFlowLogsRequest.Builder tagSpecifications(TagSpecification... tagSpecifications)

The tags to apply to the flow logs.

Parameters:

tagSpecifications - The tags to apply to the flow logs.

Returns:

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

tagSpecifications

CreateFlowLogsRequest.Builder tagSpecifications(Consumer<TagSpecification.Builder>... tagSpecifications)

The tags to apply to the flow logs.

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

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

Parameters:

tagSpecifications - a consumer that will call methods on TagSpecification.Builder

Returns:

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

See Also:

#tagSpecifications(java.util.Collection)

maxAggregationInterval

CreateFlowLogsRequest.Builder maxAggregationInterval(Integer maxAggregationInterval)

The maximum interval of time during which a flow of packets is captured and aggregated into a flow log record. The possible values are 60 seconds (1 minute) or 600 seconds (10 minutes). This parameter must be 60 seconds for transit gateway resource types.

When a network interface is attached to a Nitro-based instance, the aggregation interval is always 60 seconds or less, regardless of the value that you specify.

Default: 600

Parameters:

maxAggregationInterval - The maximum interval of time during which a flow of packets is captured and aggregated into a flow log record. The possible values are 60 seconds (1 minute) or 600 seconds (10 minutes). This parameter must be 60 seconds for transit gateway resource types.

When a network interface is attached to a Nitro-based instance, the aggregation interval is always 60 seconds or less, regardless of the value that you specify.

Default: 600

Returns:

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

destinationOptions

CreateFlowLogsRequest.Builder destinationOptions(DestinationOptionsRequest 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 CreateFlowLogsRequest.Builder destinationOptions(Consumer<DestinationOptionsRequest.Builder> destinationOptions)

The destination options.

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

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

Parameters:

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

Returns:

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

See Also:

destinationOptions(DestinationOptionsRequest)

overrideConfiguration

CreateFlowLogsRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Specified by:

overrideConfiguration in interface AwsRequest.Builder

overrideConfiguration

CreateFlowLogsRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Specified by:

overrideConfiguration in interface AwsRequest.Builder