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	deliverLogsPermissionArn(String deliverLogsPermissionArn) The ARN for the IAM role that permits Amazon EC2 to publish flow logs to a CloudWatch Logs log group in your account.
CreateFlowLogsRequest.Builder	logDestination(String logDestination) Specifies the destination to which the flow log data is to be published.
CreateFlowLogsRequest.Builder	logDestinationType(LogDestinationType logDestinationType) Specifies the type of destination to which the flow log data is to be published.
CreateFlowLogsRequest.Builder	logDestinationType(String logDestinationType) Specifies the type of destination to which the flow log data is to be published.
CreateFlowLogsRequest.Builder	logFormat(String logFormat) The fields to include in the flow log record, in the order in which they should appear.
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 ID of the subnet, network interface, or VPC for which you want to create a flow log.
CreateFlowLogsRequest.Builder	resourceIds(String... resourceIds) The ID of the subnet, network interface, or VPC for which you want to create a flow log.
CreateFlowLogsRequest.Builder	resourceType(FlowLogsResourceType resourceType) The type of resource for which to create the flow log.
CreateFlowLogsRequest.Builder	resourceType(String resourceType) The type of resource for which to create the flow log.
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 log.
CreateFlowLogsRequest.Builder	trafficType(TrafficType trafficType) The type of traffic to log.

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 for the IAM role that permits Amazon EC2 to publish flow logs to a CloudWatch Logs log group in your account.

If you specify LogDestinationType as s3, do not specify DeliverLogsPermissionArn or LogGroupName.

Parameters:

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

If you specify LogDestinationType as s3, do not specify DeliverLogsPermissionArn or LogGroupName.

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.

If you specify LogDestinationType as s3, do not specify DeliverLogsPermissionArn or LogGroupName.

Parameters:

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

If you specify LogDestinationType as s3, do not specify DeliverLogsPermissionArn or LogGroupName.

Returns:

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

resourceIds

CreateFlowLogsRequest.Builder resourceIds(Collection<String> resourceIds)

The ID of the subnet, network interface, or VPC for which you want to create a flow log.

Constraints: Maximum of 1000 resources

Parameters:

resourceIds - The ID of the subnet, network interface, or VPC for which you want to create a flow log.

Constraints: Maximum of 1000 resources

Returns:

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

resourceIds

CreateFlowLogsRequest.Builder resourceIds(String... resourceIds)

The ID of the subnet, network interface, or VPC for which you want to create a flow log.

Constraints: Maximum of 1000 resources

Parameters:

resourceIds - The ID of the subnet, network interface, or VPC for which you want to create a flow log.

Constraints: Maximum of 1000 resources

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 for which to create the flow log. For example, if you specified a VPC ID for the ResourceId property, specify VPC for this property.

Parameters:

resourceType - The type of resource for which to create the flow log. For example, if you specified a VPC ID for the ResourceId property, specify VPC for this property.

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 for which to create the flow log. For example, if you specified a VPC ID for the ResourceId property, specify VPC for this property.

Parameters:

resourceType - The type of resource for which to create the flow log. For example, if you specified a VPC ID for the ResourceId property, specify VPC for this property.

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 log. You can log traffic that the resource accepts or rejects, or all traffic.

Parameters:

trafficType - The type of traffic to log. You can log traffic that the resource accepts or rejects, or all traffic.

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 log. You can log traffic that the resource accepts or rejects, or all traffic.

Parameters:

trafficType - The type of traffic to log. You can log traffic that the resource accepts or rejects, or all traffic.

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)

Specifies the type of destination to which the flow log data is to be published. Flow log data can be published to CloudWatch Logs or Amazon S3. To publish flow log data to CloudWatch Logs, specify cloud-watch-logs. To publish flow log data to Amazon S3, specify s3.

If you specify LogDestinationType as s3, do not specify DeliverLogsPermissionArn or LogGroupName.

Default: cloud-watch-logs

Parameters:

logDestinationType - Specifies the type of destination to which the flow log data is to be published. Flow log data can be published to CloudWatch Logs or Amazon S3. To publish flow log data to CloudWatch Logs, specify cloud-watch-logs. To publish flow log data to Amazon S3, specify s3.

If you specify LogDestinationType as s3, do not specify DeliverLogsPermissionArn or LogGroupName.

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)

Specifies the type of destination to which the flow log data is to be published. Flow log data can be published to CloudWatch Logs or Amazon S3. To publish flow log data to CloudWatch Logs, specify cloud-watch-logs. To publish flow log data to Amazon S3, specify s3.

If you specify LogDestinationType as s3, do not specify DeliverLogsPermissionArn or LogGroupName.

Default: cloud-watch-logs

Parameters:

logDestinationType - Specifies the type of destination to which the flow log data is to be published. Flow log data can be published to CloudWatch Logs or Amazon S3. To publish flow log data to CloudWatch Logs, specify cloud-watch-logs. To publish flow log data to Amazon S3, specify s3.

If you specify LogDestinationType as s3, do not specify DeliverLogsPermissionArn or LogGroupName.

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)

Specifies the destination to which the flow log data is to be published. Flow log data can be published to a CloudWatch Logs log group or an Amazon S3 bucket. The value specified for this parameter depends on the value specified for LogDestinationType.

If LogDestinationType is not specified or cloud-watch-logs, specify the Amazon Resource Name (ARN) of the CloudWatch Logs log group. For example, to publish to a log group called my-logs, specify arn:aws:logs:us-east-1:123456789012:log-group:my-logs. Alternatively, use LogGroupName instead.

If LogDestinationType is s3, specify the ARN of the Amazon S3 bucket. You can also specify a subfolder in the bucket. To specify a subfolder in the bucket, use the following ARN format: bucket_ARN/subfolder_name/. For example, to specify a subfolder named my-logs in a bucket named my-bucket, use the following ARN: arn:aws:s3:::my-bucket/my-logs/. You cannot use AWSLogs as a subfolder name. This is a reserved term.

Parameters:

logDestination - Specifies the destination to which the flow log data is to be published. Flow log data can be published to a CloudWatch Logs log group or an Amazon S3 bucket. The value specified for this parameter depends on the value specified for LogDestinationType.

If LogDestinationType is not specified or cloud-watch-logs, specify the Amazon Resource Name (ARN) of the CloudWatch Logs log group. For example, to publish to a log group called my-logs, specify arn:aws:logs:us-east-1:123456789012:log-group:my-logs. Alternatively, use LogGroupName instead.

If LogDestinationType is s3, specify the ARN of the Amazon S3 bucket. You can also specify a subfolder in the bucket. To specify a subfolder in the bucket, use the following ARN format: bucket_ARN/subfolder_name/. For example, to specify a subfolder named my-logs in a bucket named my-bucket, use the following ARN: arn:aws:s3:::my-bucket/my-logs/. You cannot use AWSLogs as a subfolder name. This is a reserved term.

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, in the order in which they should appear. For a list of available fields, see Flow Log Records. If you omit this parameter, the flow log is created using the default format. If you specify this parameter, you must specify at least one field.

Specify the fields using the ${field-id} format, separated by spaces. For the AWS CLI, use single quotation marks (' ') to surround the parameter value.

Parameters:

logFormat - The fields to include in the flow log record, in the order in which they should appear. For a list of available fields, see Flow Log Records. If you omit this parameter, the flow log is created using the default format. If you specify this parameter, you must specify at least one field.

Specify the fields using the ${field-id} format, separated by spaces. For the AWS CLI, use single quotation marks (' ') to surround the parameter value.

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 that creates an instance of the List.Builder avoiding the need to create one manually via List#builder(). When the Consumer completes, List.Builder#build() is called immediately and its result is passed to #tagSpecifications(List).

Parameters:

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

Returns:

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

See Also:

#tagSpecifications(List)

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. You can specify 60 seconds (1 minute) or 600 seconds (10 minutes).

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. You can specify 60 seconds (1 minute) or 600 seconds (10 minutes).

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.

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