public static final class CfnFlowLog.Builder
extends java.lang.Object
CfnFlowLog
.Modifier and Type | Method and Description |
---|---|
CfnFlowLog |
build() |
static CfnFlowLog.Builder |
create(Construct scope,
java.lang.String id) |
CfnFlowLog.Builder |
deliverLogsPermissionArn(java.lang.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.
|
CfnFlowLog.Builder |
destinationOptions(java.lang.Object destinationOptions)
The destination options.
|
CfnFlowLog.Builder |
logDestination(java.lang.String logDestination)
The destination for the flow log data.
|
CfnFlowLog.Builder |
logDestinationType(java.lang.String logDestinationType)
The type of destination for the flow log data.
|
CfnFlowLog.Builder |
logFormat(java.lang.String logFormat)
The fields to include in the flow log record, in the order in which they should appear.
|
CfnFlowLog.Builder |
logGroupName(java.lang.String logGroupName)
The name of a new or existing CloudWatch Logs log group where Amazon EC2 publishes your flow logs.
|
CfnFlowLog.Builder |
maxAggregationInterval(java.lang.Number maxAggregationInterval)
The maximum interval of time during which a flow of packets is captured and aggregated into a flow log record.
|
CfnFlowLog.Builder |
resourceId(java.lang.String resourceId)
The ID of the resource to monitor.
|
CfnFlowLog.Builder |
resourceType(java.lang.String resourceType)
The type of resource to monitor.
|
CfnFlowLog.Builder |
tags(java.util.List<? extends CfnTag> tags)
The tags to apply to the flow logs.
|
CfnFlowLog.Builder |
trafficType(java.lang.String trafficType)
The type of traffic to monitor (accepted traffic, rejected traffic, or all traffic).
|
public static CfnFlowLog.Builder create(Construct scope, java.lang.String id)
scope
- - scope in which this resource is defined. This parameter is required.id
- - scoped id of the resource. This parameter is required.CfnFlowLog.DestinationOptionsProperty.Builder
.public CfnFlowLog.Builder resourceId(java.lang.String resourceId)
For example, if the resource type is VPC
, specify the ID of the VPC.
resourceId
- The ID of the resource to monitor. This parameter is required.this
public CfnFlowLog.Builder resourceType(java.lang.String resourceType)
resourceType
- The type of resource to monitor. This parameter is required.this
public CfnFlowLog.Builder deliverLogsPermissionArn(java.lang.String deliverLogsPermissionArn)
This parameter is required if the destination type is cloud-watch-logs
and unsupported otherwise.
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.this
public CfnFlowLog.Builder destinationOptions(java.lang.Object destinationOptions)
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
.destinationOptions
- The destination options. The following options are supported:. This parameter is required.this
public CfnFlowLog.Builder logDestination(java.lang.String logDestination)
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.
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.
kinesis-data-firehose
, specify the ARN of a Kinesis Data Firehose delivery stream. For example:arn:aws:firehose: region : account_id :deliverystream: my_stream
logDestination
- The destination for the flow log data. The meaning of this parameter depends on the destination type. This parameter is required.this
public CfnFlowLog.Builder logDestinationType(java.lang.String logDestinationType)
Default: cloud-watch-logs
logDestinationType
- The type of destination for the flow log data. This parameter is required.this
public CfnFlowLog.Builder logFormat(java.lang.String logFormat)
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.
logFormat
- The fields to include in the flow log record, in the order in which they should appear. This parameter is required.this
public CfnFlowLog.Builder logGroupName(java.lang.String logGroupName)
This parameter is valid only if the destination type is cloud-watch-logs
.
logGroupName
- The name of a new or existing CloudWatch Logs log group where Amazon EC2 publishes your flow logs. This parameter is required.this
public CfnFlowLog.Builder maxAggregationInterval(java.lang.Number maxAggregationInterval)
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
maxAggregationInterval
- The maximum interval of time during which a flow of packets is captured and aggregated into a flow log record. This parameter is required.this
public CfnFlowLog.Builder tags(java.util.List<? extends CfnTag> tags)
tags
- The tags to apply to the flow logs. This parameter is required.this
public CfnFlowLog.Builder trafficType(java.lang.String trafficType)
This parameter is not supported for transit gateway resource types. It is required for the other resource types.
trafficType
- The type of traffic to monitor (accepted traffic, rejected traffic, or all traffic). This parameter is required.this
public CfnFlowLog build()