Overview

In Kentik, a "cloud export" is an object whose properties are the values that Kentik needs to access network flow logs from a given set of resources in a given cloud provider (see Cloud Exports and Devices). The Cloud Export API enables programmatic management of cloud exports, serving two primary functions:

• Configuration of the Kentik resources required to export network flow logs and metadata from public clouds.
• Basic status information on active export processes.

Supported Cloud Providers

The functionality and configuration parameters supported by this API differ by cloud provider. The API currently supports the following providers:

• Amazon Web Services (AWS)
• Microsoft Azure
• Google Cloud (GCP)
• Oracle Cloud (OCI)

Additional Public Resources

The following additional resources are available for working with this API:

• Kentik community Python and Go SDKs provide language-specific support for using this and other Kentik APIs. These SDKs can be also used as example code for development.
• A Terraform provider is available for configuring cloud_export instances in Kentik. Terraform modules are available for AWS, Azure and GCP. These modules support onboarding and ongoing management of all resources (in public clouds and in Kentik) required to export flow logs to Kentik.

Anatomy of a Cloud Export

Configuration and status of a cloud_export instance is represented by the CloudExport object, which contains three categories of attributes:

• Common Configuration Attributes
• Cloud Provider Configuration Attributes
• Metadata and Status Attributes

Common Configuration Attributes

The configuration attributes in the table below are common to CloudExport objects for all cloud providers. | Attribute | Required | Default | |-----------|----------| ------- | | enabled | No | False | | name | Yes | | | description | No |  | | type | Yes | | | cloud_provider | Yes | | | plan_id | Yes | |

Cloud Provider Specific Attributes

The attributes listed in the table below are objects whose parameters are specific to each cloud provider. | Cloud Provider | Attribute | Object Name | |-----------|----------| ------- | | AWS | aws | AwsProperties | | Azure | azure | AzureProperties | | Google Cloud | gce | GceProperties | | OCI Cloud | oci | OciProperties |

Metadata and Status Attributes

The attributes in the table below provide read-only metadata and status for a cloud_export instance. | Attribute | Purpose | |-----------|---------| | id | System-generated unique identifier of the instance | | cdate | Creation timestamp | | edate | Last-modification timestamp | | current_status | Runtime status of the flow and metadata collection process |