FlowLog
ec2.services.k8s.aws/v1alpha1
Type | Link |
---|---|
GoDoc | ec2-controller/apis/v1alpha1#FlowLog |
Metadata
Property | Value |
---|---|
Scope | Namespaced |
Kind | FlowLog |
ListKind | FlowLogList |
Plural | flowlogs |
Singular | flowlog |
Describes a flow log.
Spec
deliverLogsPermissionARN: string
destinationOptions:
fileFormat: string
hiveCompatiblePartitions: boolean
perHourPartition: boolean
logDestination: string
logDestinationType: string
logFormat: string
logGroupName: string
maxAggregationInterval: integer
resourceID: string
resourceType: string
tags:
- key: string
value: string
trafficType: string
Field | Description |
---|---|
deliverLogsPermissionARN Optional | string 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 is kinesis-data-firehose and the delivery stream and the resources to monitor are in different accounts. |
destinationOptions Optional | object The destination options. |
destinationOptions.fileFormat Optional | string |
destinationOptions.hiveCompatiblePartitions Optional | boolean |
destinationOptions.perHourPartition Optional | boolean |
logDestination Optional | string 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 |
logDestinationType Optional | string The type of destination for the flow log data. Default: cloud-watch-logs |
logFormat Optional | string The fields to include in the flow log record. List the fields 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 (https://docs.aws.amazon.com/vpc/latest/userguide/flow-log-records.html) in the Amazon VPC User Guide or Transit Gateway Flow Log records (https://docs.aws.amazon.com/vpc/latest/tgw/tgw-flow-logs.html#flow-log-records) in the Amazon Web Services Transit Gateway Guide. Specify the fields using the ${field-id} format, separated by spaces. |
logGroupName Optional | string 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. |
maxAggregationInterval Optional | integer 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 (https://docs.aws.amazon.com/ec2/latest/instancetypes/ec2-nitro-instances.html), the aggregation interval is always 60 seconds or less, regardless of the value that you specify. Default: 600 |
resourceID Required | string |
resourceType Required | string The type of resource to monitor. |
tags Optional | array The tags. The value parameter is required, but if you don’t want the tag to have a value, specify the parameter with no value, and we set the value to an empty string. |
tags.[] Required | object Describes a tag. |
tags.[].value Optional | string |
trafficType Optional | string 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. |
Status
ackResourceMetadata:
arn: string
ownerAccountID: string
region: string
clientToken: string
conditions:
- lastTransitionTime: string
message: string
reason: string
status: string
type: string
flowLogID: string
unsuccessful:
error:
code: string
message: string
resourceID: string
Field | Description |
---|---|
ackResourceMetadata Optional | object All CRs managed by ACK have a common Status.ACKResourceMetadata memberthat is used to contain resource sync state, account ownership, constructed ARN for the resource |
ackResourceMetadata.arn Optional | string ARN is the Amazon Resource Name for the resource. This is a globally-unique identifier and is set only by the ACK service controller once the controller has orchestrated the creation of the resource OR when it has verified that an “adopted” resource (a resource where the ARN annotation was set by the Kubernetes user on the CR) exists and matches the supplied CR’s Spec field values. https://github.com/aws/aws-controllers-k8s/issues/270 |
ackResourceMetadata.ownerAccountID Required | string OwnerAccountID is the AWS Account ID of the account that owns the backend AWS service API resource. |
ackResourceMetadata.region Required | string Region is the AWS region in which the resource exists or will exist. |
clientToken Optional | string Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. |
conditions Optional | array All CRS managed by ACK have a common Status.Conditions member thatcontains a collection of ackv1alpha1.Condition objects that describethe various terminal states of the CR and its backend AWS service API resource |
conditions.[] Required | object Condition is the common struct used by all CRDs managed by ACK service |
controllers to indicate terminal states of the CR and its backend AWS | |
service API resource | |
conditions.[].message Optional | string A human readable message indicating details about the transition. |
conditions.[].reason Optional | string The reason for the condition’s last transition. |
conditions.[].status Optional | string Status of the condition, one of True, False, Unknown. |
conditions.[].type Optional | string Type is the type of the Condition |
flowLogID Optional | string |
unsuccessful Optional | array Information about the flow logs that could not be created successfully. |
unsuccessful.[] Required | object Information about items that were not successfully processed in a batch call. |
unsuccessful.[].error.code Optional | string |
unsuccessful.[].error.message Optional | string |
unsuccessful.[].resourceID Optional | string |