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.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:38.170Z")
 @Stability(value=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")
         .trafficType("trafficType")
         // 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()))
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	CfnFlowLogProps.Builder A builder for CfnFlowLogProps
static class	CfnFlowLogProps.Jsii$Proxy An implementation for CfnFlowLogProps

Method Summary

Modifier and Type	Method and Description
static CfnFlowLogProps.Builder	builder()
default String	getDeliverLogsPermissionArn() The ARN for the IAM role that permits Amazon EC2 to publish flow logs to a CloudWatch Logs log group in your account.
default Object	getDestinationOptions() The destination options.
default String	getLogDestination() The destination to which the flow log data is to be published.
default String	getLogDestinationType() The type of destination to which the flow log data is to be published.
default String	getLogFormat() The fields to include in the flow log record, in the order in which they should appear.
default String	getLogGroupName() The name of a new or existing CloudWatch Logs log group where Amazon EC2 publishes your flow logs.
default Number	getMaxAggregationInterval() The maximum interval of time during which a flow of packets is captured and aggregated into a flow log record.
String	getResourceId() The ID of the subnet, network interface, or VPC for which you want to create a flow log.
String	getResourceType() The type of resource for which to create the flow log.
default List<CfnTag>	getTags() The tags to apply to the flow logs.
String	getTrafficType() The type of traffic to log.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getResourceId

@Stability(value=Stable)
 @NotNull
String getResourceId()

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

getResourceType

@Stability(value=Stable)
 @NotNull
String getResourceType()

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.

getTrafficType

@Stability(value=Stable)
 @NotNull
String getTrafficType()

The type of traffic to log.

You can log traffic that the resource accepts or rejects, or all traffic.

getDeliverLogsPermissionArn

@Stability(value=Stable)
 @Nullable
default String getDeliverLogsPermissionArn()

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 .

getDestinationOptions

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

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.

getLogDestinationType

@Stability(value=Stable)
 @Nullable
default String getLogDestinationType()

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

getLogFormat

@Stability(value=Stable)
 @Nullable
default String getLogFormat()

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.

getLogGroupName

@Stability(value=Stable)
 @Nullable
default String getLogGroupName()

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 .

getMaxAggregationInterval

@Stability(value=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.

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

getTags

@Stability(value=Stable)
 @Nullable
default List<CfnTag> getTags()

The tags to apply to the flow logs.

builder

@Stability(value=Stable)
static CfnFlowLogProps.Builder builder()

Returns:

a CfnFlowLogProps.Builder of CfnFlowLogProps