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 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. |
| destinationOptions Optional | object The destination options. |
| destinationOptions.fileFormat Optional | string |
| destinationOptions.hiveCompatiblePartitions Optional | boolean |
| destinationOptions.perHourPartition Optional | boolean |
| logDestination Optional | string 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. |
| logDestinationType Optional | string 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 |
| logFormat Optional | string 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 (https://docs.aws.amazon.com/vpc/latest/userguide/flow-logs.html#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. For the CLI, surround this parameter value with single quotes on Linux or double quotes on Windows. |
| logGroupName Optional | string 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. |
| maxAggregationInterval Optional | integer 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 (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html#ec2-nitro-instances), 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 for which to create the flow log. For example, if you specified a VPC ID for the ResourceId property, specify VPC for this property. |
| 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 log. You can log traffic that the resource accepts or rejects, or all traffic. |
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. TODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse 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 |