get-flow-logs-integration-template¶

Description¶

Generates a CloudFormation template that streamlines and automates the integration of VPC flow logs with Amazon Athena. This make it easier for you to query and gain insights from VPC flow logs data. Based on the information that you provide, we configure resources in the template to do the following:

Create a table in Athena that maps fields to a custom log format
Create a Lambda function that updates the table with new partitions on a daily, weekly, or monthly basis
Create a table partitioned between two timestamps in the past
Create a set of named queries in Athena that you can use to get started quickly

Synopsis¶

  get-flow-logs-integration-template
[--dry-run | --no-dry-run]
--flow-log-id <value>
--config-delivery-s3-destination-arn <value>
--integrate-services <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options¶

--dry-run | --no-dry-run (boolean)

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation . Otherwise, it is UnauthorizedOperation .

--flow-log-id (string)

The ID of the flow log.

--config-delivery-s3-destination-arn (string)

To store the CloudFormation template in Amazon S3, specify the location in Amazon S3.

--integrate-services (structure)

Information about the service integration.

AthenaIntegrations -> (list)

Information about the integration with Amazon Athena.

(structure)

Describes integration options for Amazon Athena.

IntegrationResultS3DestinationArn -> (string)

The location in Amazon S3 to store the generated CloudFormation template.

PartitionLoadFrequency -> (string)

The schedule for adding new partitions to the table.

PartitionStartDate -> (timestamp)

The start date for the partition.

PartitionEndDate -> (timestamp)

The end date for the partition.

Shorthand Syntax:

AthenaIntegrations=[{IntegrationResultS3DestinationArn=string,PartitionLoadFrequency=string,PartitionStartDate=timestamp,PartitionEndDate=timestamp},{IntegrationResultS3DestinationArn=string,PartitionLoadFrequency=string,PartitionStartDate=timestamp,PartitionEndDate=timestamp}]

JSON Syntax:

{
  "AthenaIntegrations": [
    {
      "IntegrationResultS3DestinationArn": "string",
      "PartitionLoadFrequency": "none"|"daily"|"weekly"|"monthly",
      "PartitionStartDate": timestamp,
      "PartitionEndDate": timestamp
    }
    ...
  ]
}

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

See ‘aws help’ for descriptions of global parameters.

Examples¶

Note

To use the following examples, you must have the AWS CLI installed and configured. See the Getting started guide in the AWS CLI User Guide for more information.

Unless otherwise stated, all examples have unix-like quotation rules. These examples will need to be adapted to your terminal’s quoting rules. See Using quotation marks with strings in the AWS CLI User Guide .

To create a CloudFormation template to automate the integration of VPC flow logs with Amazon Athena

The following get-flow-logs-integration-template examples create a CloudFormation template to automate the integration of VPC flow logs with Amazon Athena.

Linux:

aws ec2 get-flow-logs-integration-template \
    --flow-log-id fl-1234567890abcdef0 \
    --config-delivery-s3-destination-arn arn:aws:s3:::DOC-EXAMPLE-BUCKET \
    --integrate-services AthenaIntegrations='[{IntegrationResultS3DestinationArn=arn:aws:s3:::DOC-EXAMPLE-BUCKET,PartitionLoadFrequency=none,PartitionStartDate=2021-07-21T00:40:00,PartitionEndDate=2021-07-21T00:42:00},{IntegrationResultS3DestinationArn=arn:aws:s3:::DOC-EXAMPLE-BUCKET,PartitionLoadFrequency=none,PartitionStartDate=2021-07-21T00:40:00,PartitionEndDate=2021-07-21T00:42:00}]'

Windows:

aws ec2 get-flow-logs-integration-template ^
    --flow-log-id fl-1234567890abcdef0 ^
    --config-delivery-s3-destination-arn arn:aws:s3:::DOC-EXAMPLE-BUCKET ^
    --integrate-services AthenaIntegrations=[{IntegrationResultS3DestinationArn=arn:aws:s3:::DOC-EXAMPLE-BUCKET,PartitionLoadFrequency=none,PartitionStartDate=2021-07-21T00:40:00,PartitionEndDate=2021-07-21T00:42:00},{IntegrationResultS3DestinationArn=arn:aws:s3:::DOC-EXAMPLE-BUCKET,PartitionLoadFrequency=none,PartitionStartDate=2021-07-21T00:40:00,PartitionEndDate=2021-07-21T00:42:00}]

Output:

{
    "Result": "https://DOC-EXAMPLE-BUCKET.s3.us-east-2.amazonaws.com/VPCFlowLogsIntegrationTemplate_fl-1234567890abcdef0_Wed%20Jul%2021%2000%3A57%3A56%20UTC%202021.yml"
}

For information on using CloudFormation templates, see Working with AWS CloudFormation templates in the AWS CloudFormation User Guide.

For information on using Amazon Athena and flow logs, see Query flow logs using Amazon Athena in the Amazon Virtual Private Cloud User Guide.

Output¶

Result -> (string)

The generated CloudFormation template.

Table of Contents

Feedback

User Guide