Class: AWSCDK::EC2::LogFormat

Inherits:
Jsii::Object
  • Object
show all
Defined in:
ec2/log_format.rb

Overview

The following table describes all of the available fields for a flow log record.

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(value) ⇒ LogFormat

Returns a new instance of LogFormat.

Parameters:

  • value (String) 


9
10
11
12
 
# File 'ec2/log_format.rb', line 9

def initialize(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "value")
  Jsii::Object.instance_method(:initialize).bind(self).call(value)
end

Class Method Details

.ACCOUNT_ID ⇒ AWSCDK::EC2::LogFormat

The AWS account ID of the owner of the source network interface for which traffic is recorded.

Returns:

  • (AWSCDK::EC2::LogFormat) 


46
47
48
 
# File 'ec2/log_format.rb', line 46

def self.ACCOUNT_ID()
  Jsii::Kernel.instance.get_static("aws-cdk-lib.aws_ec2.LogFormat", "ACCOUNT_ID")
end

.ACTION ⇒ AWSCDK::EC2::LogFormat

The action that is associated with the traffic.

Returns:

  • (AWSCDK::EC2::LogFormat) 


53
54
55
 
# File 'ec2/log_format.rb', line 53

def self.ACTION()
  Jsii::Kernel.instance.get_static("aws-cdk-lib.aws_ec2.LogFormat", "ACTION")
end

.ALL_DEFAULT_FIELDS ⇒ AWSCDK::EC2::LogFormat

The default format.

Returns:

  • (AWSCDK::EC2::LogFormat) 


60
61
62
 
# File 'ec2/log_format.rb', line 60

def self.ALL_DEFAULT_FIELDS()
  Jsii::Kernel.instance.get_static("aws-cdk-lib.aws_ec2.LogFormat", "ALL_DEFAULT_FIELDS")
end

.AZ_ID ⇒ AWSCDK::EC2::LogFormat

The ID of the Availability Zone that contains the network interface for which traffic is recorded.

Returns:

  • (AWSCDK::EC2::LogFormat) 


67
68
69
 
# File 'ec2/log_format.rb', line 67

def self.AZ_ID()
  Jsii::Kernel.instance.get_static("aws-cdk-lib.aws_ec2.LogFormat", "AZ_ID")
end

.BYTES ⇒ AWSCDK::EC2::LogFormat

The number of bytes transferred during the flow.

Returns:

  • (AWSCDK::EC2::LogFormat) 


74
75
76
 
# File 'ec2/log_format.rb', line 74

def self.BYTES()
  Jsii::Kernel.instance.get_static("aws-cdk-lib.aws_ec2.LogFormat", "BYTES")
end

.custom(format_string) ⇒ AWSCDK::EC2::LogFormat

A custom format string.

Gives full control over the format string fragment.

Parameters:

  • format_string (String)

Returns:

  • (AWSCDK::EC2::LogFormat) 


26
27
28
29
 
# File 'ec2/log_format.rb', line 26

def self.custom(format_string)
  Jsii::Type.check_type(format_string, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "formatString")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_ec2.LogFormat", "custom", [format_string])
end

.DST_ADDR ⇒ AWSCDK::EC2::LogFormat

The destination address for outgoing traffic, or the IPv4 or IPv6 address of the network interface for incoming traffic on the network interface.

Returns:

  • (AWSCDK::EC2::LogFormat) 


81
82
83
 
# File 'ec2/log_format.rb', line 81

def self.DST_ADDR()
  Jsii::Kernel.instance.get_static("aws-cdk-lib.aws_ec2.LogFormat", "DST_ADDR")
end

.DST_PORT ⇒ AWSCDK::EC2::LogFormat

The destination port of the traffic.

Returns:

  • (AWSCDK::EC2::LogFormat) 


88
89
90
 
# File 'ec2/log_format.rb', line 88

def self.DST_PORT()
  Jsii::Kernel.instance.get_static("aws-cdk-lib.aws_ec2.LogFormat", "DST_PORT")
end

.ECS_CLUSTER_ARN ⇒ AWSCDK::EC2::LogFormat

AWS Resource Name (ARN) of the ECS cluster if the traffic is from a running ECS task.

Returns:

  • (AWSCDK::EC2::LogFormat) 


95
96
97
 
# File 'ec2/log_format.rb', line 95

def self.ECS_CLUSTER_ARN()
  Jsii::Kernel.instance.get_static("aws-cdk-lib.aws_ec2.LogFormat", "ECS_CLUSTER_ARN")
end

.ECS_CLUSTER_NAME ⇒ AWSCDK::EC2::LogFormat

Name of the ECS cluster if the traffic is from a running ECS task.

Returns:

  • (AWSCDK::EC2::LogFormat) 


102
103
104
 
# File 'ec2/log_format.rb', line 102

def self.ECS_CLUSTER_NAME()
  Jsii::Kernel.instance.get_static("aws-cdk-lib.aws_ec2.LogFormat", "ECS_CLUSTER_NAME")
end

.ECS_CONTAINER_ID ⇒ AWSCDK::EC2::LogFormat

Docker runtime ID of the container if the traffic is from a running ECS task.

If there is one container or more in the ECS task, this will be the docker runtime ID of the first container.

Returns:

  • (AWSCDK::EC2::LogFormat) 


111
112
113
 
# File 'ec2/log_format.rb', line 111

def self.ECS_CONTAINER_ID()
  Jsii::Kernel.instance.get_static("aws-cdk-lib.aws_ec2.LogFormat", "ECS_CONTAINER_ID")
end

.ECS_CONTAINER_INSTANCE_ARN ⇒ AWSCDK::EC2::LogFormat

ARN of the ECS container instance if the traffic is from a running ECS task on an EC2 instance.

Returns:

  • (AWSCDK::EC2::LogFormat) 


118
119
120
 
# File 'ec2/log_format.rb', line 118

def self.ECS_CONTAINER_INSTANCE_ARN()
  Jsii::Kernel.instance.get_static("aws-cdk-lib.aws_ec2.LogFormat", "ECS_CONTAINER_INSTANCE_ARN")
end

.ECS_CONTAINER_INSTANCE_ID ⇒ AWSCDK::EC2::LogFormat

ID of the ECS container instance if the traffic is from a running ECS task on an EC2 instance.

Returns:

  • (AWSCDK::EC2::LogFormat) 


125
126
127
 
# File 'ec2/log_format.rb', line 125

def self.ECS_CONTAINER_INSTANCE_ID()
  Jsii::Kernel.instance.get_static("aws-cdk-lib.aws_ec2.LogFormat", "ECS_CONTAINER_INSTANCE_ID")
end

.ECS_SECOND_CONTAINER_ID ⇒ AWSCDK::EC2::LogFormat

Docker runtime ID of the container if the traffic is from a running ECS task.

If there is more than one container in the ECS task, this will be the Docker runtime ID of the second container.

Returns:

  • (AWSCDK::EC2::LogFormat) 


134
135
136
 
# File 'ec2/log_format.rb', line 134

def self.ECS_SECOND_CONTAINER_ID()
  Jsii::Kernel.instance.get_static("aws-cdk-lib.aws_ec2.LogFormat", "ECS_SECOND_CONTAINER_ID")
end

.ECS_SERVICE_NAME ⇒ AWSCDK::EC2::LogFormat

Name of the ECS service if the traffic is from a running ECS task and the ECS task is started by an ECS service.

Returns:

  • (AWSCDK::EC2::LogFormat) 


141
142
143
 
# File 'ec2/log_format.rb', line 141

def self.ECS_SERVICE_NAME()
  Jsii::Kernel.instance.get_static("aws-cdk-lib.aws_ec2.LogFormat", "ECS_SERVICE_NAME")
end

.ECS_TASK_ARN ⇒ AWSCDK::EC2::LogFormat

ARN of the ECS task if the traffic is from a running ECS task.

Returns:

  • (AWSCDK::EC2::LogFormat) 


148
149
150
 
# File 'ec2/log_format.rb', line 148

def self.ECS_TASK_ARN()
  Jsii::Kernel.instance.get_static("aws-cdk-lib.aws_ec2.LogFormat", "ECS_TASK_ARN")
end

.ECS_TASK_DEFINITION_ARN ⇒ AWSCDK::EC2::LogFormat

ARN of the ECS task definition if the traffic is from a running ECS task.

Returns:

  • (AWSCDK::EC2::LogFormat) 


155
156
157
 
# File 'ec2/log_format.rb', line 155

def self.ECS_TASK_DEFINITION_ARN()
  Jsii::Kernel.instance.get_static("aws-cdk-lib.aws_ec2.LogFormat", "ECS_TASK_DEFINITION_ARN")
end

.ECS_TASK_ID ⇒ AWSCDK::EC2::LogFormat

ID of the ECS task if the traffic is from a running ECS task.

Returns:

  • (AWSCDK::EC2::LogFormat) 


162
163
164
 
# File 'ec2/log_format.rb', line 162

def self.ECS_TASK_ID()
  Jsii::Kernel.instance.get_static("aws-cdk-lib.aws_ec2.LogFormat", "ECS_TASK_ID")
end

.END_TIMESTAMP ⇒ AWSCDK::EC2::LogFormat

The time, in Unix seconds, when the last packet of the flow was received within the aggregation interval.

This might be up to 60 seconds after the packet was transmitted or received on the network interface.

Returns:

  • (AWSCDK::EC2::LogFormat) 


172
173
174
 
# File 'ec2/log_format.rb', line 172

def self.END_TIMESTAMP()
  Jsii::Kernel.instance.get_static("aws-cdk-lib.aws_ec2.LogFormat", "END_TIMESTAMP")
end

.field(field) ⇒ AWSCDK::EC2::LogFormat

A custom field name.

If there is no ready-made constant for a new field yet, you can use this. The field name will automatically be wrapped in ${ ... }.

Parameters:

  • field (String)

Returns:

  • (AWSCDK::EC2::LogFormat) 


38
39
40
41
 
# File 'ec2/log_format.rb', line 38

def self.field(field)
  Jsii::Type.check_type(field, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "field")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_ec2.LogFormat", "field", [field])
end

.FLOW_DIRECTION ⇒ AWSCDK::EC2::LogFormat

The direction of the flow with respect to the interface where traffic is captured.

Returns:

  • (AWSCDK::EC2::LogFormat) 


179
180
181
 
# File 'ec2/log_format.rb', line 179

def self.FLOW_DIRECTION()
  Jsii::Kernel.instance.get_static("aws-cdk-lib.aws_ec2.LogFormat", "FLOW_DIRECTION")
end

.INSTANCE_ID ⇒ AWSCDK::EC2::LogFormat

The ID of the instance that's associated with network interface for which the traffic is recorded, if the instance is owned by you.

Returns a '-' symbol for a requester-managed network interface; for example, the network interface for a NAT gateway

Returns:

  • (AWSCDK::EC2::LogFormat) 


189
190
191
 
# File 'ec2/log_format.rb', line 189

def self.INSTANCE_ID()
  Jsii::Kernel.instance.get_static("aws-cdk-lib.aws_ec2.LogFormat", "INSTANCE_ID")
end

.INTERFACE_ID ⇒ AWSCDK::EC2::LogFormat

The ID of the network interface for which the traffic is recorded.

Returns:

  • (AWSCDK::EC2::LogFormat) 


196
197
198
 
# File 'ec2/log_format.rb', line 196

def self.INTERFACE_ID()
  Jsii::Kernel.instance.get_static("aws-cdk-lib.aws_ec2.LogFormat", "INTERFACE_ID")
end

.jsii_overridable_methods ⇒ Object 



14
15
16
17
18
 
# File 'ec2/log_format.rb', line 14

def self.jsii_overridable_methods
  {
    :value => { kind: :property, name: "value", is_optional: false },
  }
end

.LOG_STATUS ⇒ AWSCDK::EC2::LogFormat

The logging status of the flow log.

Returns:

  • (AWSCDK::EC2::LogFormat) 


203
204
205
 
# File 'ec2/log_format.rb', line 203

def self.LOG_STATUS()
  Jsii::Kernel.instance.get_static("aws-cdk-lib.aws_ec2.LogFormat", "LOG_STATUS")
end

.PACKETS ⇒ AWSCDK::EC2::LogFormat

The number of packets transferred during the flow.

Returns:

  • (AWSCDK::EC2::LogFormat) 


210
211
212
 
# File 'ec2/log_format.rb', line 210

def self.PACKETS()
  Jsii::Kernel.instance.get_static("aws-cdk-lib.aws_ec2.LogFormat", "PACKETS")
end

.PKT_DST_ADDR ⇒ AWSCDK::EC2::LogFormat

The packet-level (original) destination IP address for the traffic.

Returns:

  • (AWSCDK::EC2::LogFormat) 


217
218
219
 
# File 'ec2/log_format.rb', line 217

def self.PKT_DST_ADDR()
  Jsii::Kernel.instance.get_static("aws-cdk-lib.aws_ec2.LogFormat", "PKT_DST_ADDR")
end

.PKT_DST_AWS_SERVICE ⇒ AWSCDK::EC2::LogFormat

The name of the subset of IP address ranges for the pkt-dstaddr field, if the destination IP address is for an AWS service.

Returns:

  • (AWSCDK::EC2::LogFormat) 


224
225
226
 
# File 'ec2/log_format.rb', line 224

def self.PKT_DST_AWS_SERVICE()
  Jsii::Kernel.instance.get_static("aws-cdk-lib.aws_ec2.LogFormat", "PKT_DST_AWS_SERVICE")
end

.PKT_SRC_ADDR ⇒ AWSCDK::EC2::LogFormat

The packet-level (original) source IP address of the traffic.

Returns:

  • (AWSCDK::EC2::LogFormat) 


231
232
233
 
# File 'ec2/log_format.rb', line 231

def self.PKT_SRC_ADDR()
  Jsii::Kernel.instance.get_static("aws-cdk-lib.aws_ec2.LogFormat", "PKT_SRC_ADDR")
end

.PKT_SRC_AWS_SERVICE ⇒ AWSCDK::EC2::LogFormat

The name of the subset of IP address ranges for the pkt-srcaddr field, if the source IP address is for an AWS service.

Returns:

  • (AWSCDK::EC2::LogFormat) 


238
239
240
 
# File 'ec2/log_format.rb', line 238

def self.PKT_SRC_AWS_SERVICE()
  Jsii::Kernel.instance.get_static("aws-cdk-lib.aws_ec2.LogFormat", "PKT_SRC_AWS_SERVICE")
end

.PROTOCOL ⇒ AWSCDK::EC2::LogFormat

The IANA protocol number of the traffic.

Returns:

  • (AWSCDK::EC2::LogFormat) 


245
246
247
 
# File 'ec2/log_format.rb', line 245

def self.PROTOCOL()
  Jsii::Kernel.instance.get_static("aws-cdk-lib.aws_ec2.LogFormat", "PROTOCOL")
end

.REGION ⇒ AWSCDK::EC2::LogFormat

The Region that contains the network interface for which traffic is recorded.

Returns:

  • (AWSCDK::EC2::LogFormat) 


252
253
254
 
# File 'ec2/log_format.rb', line 252

def self.REGION()
  Jsii::Kernel.instance.get_static("aws-cdk-lib.aws_ec2.LogFormat", "REGION")
end

.SRC_ADDR ⇒ AWSCDK::EC2::LogFormat

The source address for incoming traffic, or the IPv4 or IPv6 address of the network interface for outgoing traffic on the network interface.

Returns:

  • (AWSCDK::EC2::LogFormat) 


259
260
261
 
# File 'ec2/log_format.rb', line 259

def self.SRC_ADDR()
  Jsii::Kernel.instance.get_static("aws-cdk-lib.aws_ec2.LogFormat", "SRC_ADDR")
end

.SRC_PORT ⇒ AWSCDK::EC2::LogFormat

The source port of the traffic.

Returns:

  • (AWSCDK::EC2::LogFormat) 


266
267
268
 
# File 'ec2/log_format.rb', line 266

def self.SRC_PORT()
  Jsii::Kernel.instance.get_static("aws-cdk-lib.aws_ec2.LogFormat", "SRC_PORT")
end

.START_TIMESTAMP ⇒ AWSCDK::EC2::LogFormat

The time, in Unix seconds, when the first packet of the flow was received within the aggregation interval.

This might be up to 60 seconds after the packet was transmitted or received on the network interface.

Returns:

  • (AWSCDK::EC2::LogFormat) 


276
277
278
 
# File 'ec2/log_format.rb', line 276

def self.START_TIMESTAMP()
  Jsii::Kernel.instance.get_static("aws-cdk-lib.aws_ec2.LogFormat", "START_TIMESTAMP")
end

.SUBLOCATION_ID ⇒ AWSCDK::EC2::LogFormat

The ID of the sublocation that contains the network interface for which traffic is recorded.

Returns:

  • (AWSCDK::EC2::LogFormat) 


283
284
285
 
# File 'ec2/log_format.rb', line 283

def self.SUBLOCATION_ID()
  Jsii::Kernel.instance.get_static("aws-cdk-lib.aws_ec2.LogFormat", "SUBLOCATION_ID")
end

.SUBLOCATION_TYPE ⇒ AWSCDK::EC2::LogFormat

The type of sublocation that's returned in the sublocation-id field.

Returns:

  • (AWSCDK::EC2::LogFormat) 


290
291
292
 
# File 'ec2/log_format.rb', line 290

def self.SUBLOCATION_TYPE()
  Jsii::Kernel.instance.get_static("aws-cdk-lib.aws_ec2.LogFormat", "SUBLOCATION_TYPE")
end

.SUBNET_ID ⇒ AWSCDK::EC2::LogFormat

The ID of the subnet that contains the network interface for which the traffic is recorded.

Returns:

  • (AWSCDK::EC2::LogFormat) 


297
298
299
 
# File 'ec2/log_format.rb', line 297

def self.SUBNET_ID()
  Jsii::Kernel.instance.get_static("aws-cdk-lib.aws_ec2.LogFormat", "SUBNET_ID")
end

.TCP_FLAGS ⇒ AWSCDK::EC2::LogFormat

The bitmask value for TCP flags.

  • FIN -- 1
  • SYN -- 2
  • RST -- 4
  • SYN-ACK -- 18

If no supported flags are recorded, the TCP flag value is 0.

TCP flags can be OR-ed during the aggregation interval. For short connections, the flags might be set on the same line in the flow log record, for example, 19 for SYN-ACK and FIN, and 3 for SYN and FIN.

Returns:

  • (AWSCDK::EC2::LogFormat) 


315
316
317
 
# File 'ec2/log_format.rb', line 315

def self.TCP_FLAGS()
  Jsii::Kernel.instance.get_static("aws-cdk-lib.aws_ec2.LogFormat", "TCP_FLAGS")
end

.TRAFFIC_PATH ⇒ AWSCDK::EC2::LogFormat

The path that egress traffic takes to the destination.

Returns:

  • (AWSCDK::EC2::LogFormat) 


322
323
324
 
# File 'ec2/log_format.rb', line 322

def self.TRAFFIC_PATH()
  Jsii::Kernel.instance.get_static("aws-cdk-lib.aws_ec2.LogFormat", "TRAFFIC_PATH")
end

.TRAFFIC_TYPE ⇒ AWSCDK::EC2::LogFormat

The type of traffic.

The possible values are IPv4, IPv6, or EFA.

Returns:

  • (AWSCDK::EC2::LogFormat) 


331
332
333
 
# File 'ec2/log_format.rb', line 331

def self.TRAFFIC_TYPE()
  Jsii::Kernel.instance.get_static("aws-cdk-lib.aws_ec2.LogFormat", "TRAFFIC_TYPE")
end

.VERSION ⇒ AWSCDK::EC2::LogFormat

The VPC Flow Logs version.

Returns:

  • (AWSCDK::EC2::LogFormat) 


338
339
340
 
# File 'ec2/log_format.rb', line 338

def self.VERSION()
  Jsii::Kernel.instance.get_static("aws-cdk-lib.aws_ec2.LogFormat", "VERSION")
end

.VPC_ID ⇒ AWSCDK::EC2::LogFormat

The ID of the VPC that contains the network interface for which the traffic is recorded.

Returns:

  • (AWSCDK::EC2::LogFormat) 


345
346
347
 
# File 'ec2/log_format.rb', line 345

def self.VPC_ID()
  Jsii::Kernel.instance.get_static("aws-cdk-lib.aws_ec2.LogFormat", "VPC_ID")
end

Instance Method Details

#value ⇒ String

Returns:

  • (String) 


350
351
352
 
# File 'ec2/log_format.rb', line 350

def value()
  jsii_get_property("value")
end