Package software.amazon.awscdk.services.ec2

Interface CfnFlowLogProps

All Superinterfaces:
software.amazon.jsii.JsiiSerializable
All Known Implementing Classes:
CfnFlowLogProps.Jsii$Proxy
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:30:38.564Z") @Stability(Stable) public interface CfnFlowLogProps extends software.amazon.jsii.JsiiSerializable
Properties for defining a CfnFlowLog.

Example: 

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.ec2.*;
 Object destinationOptions;
 CfnFlowLogProps cfnFlowLogProps = CfnFlowLogProps.builder()
         .resourceId("resourceId")
         .resourceType("resourceType")
         // the properties below are optional
         .deliverLogsPermissionArn("deliverLogsPermissionArn")
         .destinationOptions(destinationOptions)
         .logDestination("logDestination")
         .logDestinationType("logDestinationType")
         .logFormat("logFormat")
         .logGroupName("logGroupName")
         .maxAggregationInterval(123)
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .trafficType("trafficType")
         .build();

  • Method Details

    • getResourceId

      @Stability(Stable) @NotNull String getResourceId()
      The ID of the resource to monitor.

      For example, if the resource type is VPC , specify the ID of the VPC.

    • getResourceType

      @Stability(Stable) @NotNull String getResourceType()
      The type of resource to monitor.

    • getDeliverLogsPermissionArn

      @Stability(Stable) @Nullable default String getDeliverLogsPermissionArn()
      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.

    • getDestinationOptions

      @Stability(Stable) @Nullable default Object getDestinationOptions()
      The destination options. The following options are supported:.

      • FileFormat - The format for the flow log ( plain-text | parquet ). The default is plain-text .
      • HiveCompatiblePartitions - Indicates whether to use Hive-compatible prefixes for flow logs stored in Amazon S3 ( true | false ). The default is false .
      • PerHourPartition - Indicates whether to partition the flow log per hour ( true | false ). The default is false .

    • getLogDestination

      @Stability(Stable) @Nullable default String getLogDestination()
      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

    • getLogDestinationType

      @Stability(Stable) @Nullable default String getLogDestinationType()
      The type of destination for the flow log data.

      Default: cloud-watch-logs

    • getLogFormat

      @Stability(Stable) @Nullable default String getLogFormat()
      The fields to include in the flow log record, 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 AWS Transit Gateway Guide .

      Specify the fields using the ${field-id} format, separated by spaces.

    • getLogGroupName

      @Stability(Stable) @Nullable default String getLogGroupName()
      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 .

    • getMaxAggregationInterval

      @Stability(Stable) @Nullable default Number getMaxAggregationInterval()
      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

    • getTags

      @Stability(Stable) @Nullable default List<CfnTag> getTags()
      The tags to apply to the flow logs.

    • getTrafficType

      @Stability(Stable) @Nullable default String getTrafficType()
      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.

    • builder

      @Stability(Stable) static CfnFlowLogProps.Builder builder()
      Returns:
      a CfnFlowLogProps.Builder of CfnFlowLogProps