Interface CfnFlowLogProps
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
CfnFlowLogProps.Jsii$Proxy
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
.deliverCrossAccountRole("deliverCrossAccountRole")
.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();
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic final classA builder forCfnFlowLogPropsstatic final classAn implementation forCfnFlowLogProps -
Method Summary
Modifier and TypeMethodDescriptionstatic CfnFlowLogProps.Builderbuilder()default StringThe ARN of the IAM role that allows the service to publish flow logs across accounts.default StringThe ARN of the IAM role that allows Amazon EC2 to publish flow logs to the log destination.default ObjectThe destination options.default StringThe destination for the flow log data.default StringThe type of destination for the flow log data.default StringThe fields to include in the flow log record, in the order in which they should appear.default StringThe name of a new or existing CloudWatch Logs log group where Amazon EC2 publishes your flow logs.default NumberThe maximum interval of time during which a flow of packets is captured and aggregated into a flow log record.The ID of the resource to monitor.The type of resource to monitor.getTags()The tags to apply to the flow logs.default StringThe type of traffic to monitor (accepted traffic, rejected traffic, or all traffic).Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
getResourceId
The ID of the resource to monitor.For example, if the resource type is
VPC, specify the ID of the VPC.- See Also:
-
getResourceType
The type of resource to monitor.- See Also:
-
getDeliverCrossAccountRole
The ARN of the IAM role that allows the service to publish flow logs across accounts.- See Also:
-
getDeliverLogsPermissionArn
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 iskinesis-data-firehoseand the delivery stream and the resources to monitor are in different accounts.- See Also:
-
getDestinationOptions
The destination options.- See Also:
-
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
LogGroupNameparameter.- 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
AWSLogsas 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
- See Also:
- If the destination type is
-
getLogDestinationType
The type of destination for the flow log data.Default:
cloud-watch-logs- See Also:
-
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.- See Also:
-
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.- See Also:
-
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
- See Also:
-
getTags
The tags to apply to the flow logs.- See Also:
-
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.
- See Also:
-
builder
- Returns:
- a
CfnFlowLogProps.BuilderofCfnFlowLogProps
-