Package software.amazon.awssdk.services.ec2.model

Interface CreateFlowLogsRequest.Builder

    • Method Detail

      • dryRun

        CreateFlowLogsRequest.Builder dryRun​(Boolean dryRun)

        Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

        Parameters:
        dryRun - Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • 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 the log destination.

        This parameter is required if the destination type is cloud-watch-logs, or if the destination type is kinesis-data-firehose and the delivery stream and the resources to monitor are in different accounts.

        Parameters:
        deliverLogsPermissionArn - The ARN of the IAM role that allows Amazon EC2 to publish flow logs to the log destination.

        This parameter is required if the destination type is cloud-watch-logs, or if the destination type is kinesis-data-firehose and the delivery stream and the resources to monitor are in different accounts.

        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.

      • 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.

        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.

        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.

      • 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.