Kinesis Firehose Connector

Overview

The kinesis-firehose-addon and kinesis-firehose-connector modules combine to add AWS Kinesis Data Stream access to the Sym Runtime.

Kinesis Firehose Addon

The kinesis-firehose-addon module adds a policy granting AWS Kinesis Firehose access to the Sym Runtime Connector module.

You typically include this Addon by adding aws/kinesis-firehose to the addons property of the Runtime Connector module, rather than referring to the policy ARN itself.

Kinesis Firehoses must be tagged with ${var.tag_name}=${var.environment} in order to be accessible by this addon.

module "runtime_connector" {
  source  = "terraform.symops.com/symopsio/runtime-connector/sym"
  version = ">= 1.0.0"

  addons      = ["aws/kinesis-firehose"]
  environment = "sandbox"
}

Outputs

NameDescription
policy_arnKinesis Firehose's access policy arn

Inputs

NameDescriptionTypeDefaultRequired
environmentAn environment qualifier for the resources this module creates, to support a Terraform SDLC. The environment value is also the tag value that secrets must be tagged with to be accessible by this addon.stringn/ayes
tag_nameName of the tag that resources must be tagged with to be accessible by this addon.string"SymEnv"no
tagsAdditional tags to apply to resourcesmap(string){}no

Required Inputs

The following input variables are required:

Description: An environment qualifier for the resources this module creates, to support a Terraform SDLC. The environment value is also the tag value that secrets must be tagged with to be accessible by this addon.

Type: string

Optional Inputs

The following input variables are optional (have default values):

Description: Name of the tag that resources must be tagged with to be accessible by this addon.

Type: string

Default: "SymEnv"

Description: Additional tags to apply to resources

Type: map(string)

Default: {}

Kinesis Firehose Connector

To provide the Sym Runtime with access to the resources created in this Connector, use the aws/kinesis-firehose addon in the runtime-connector module as described above.

module "kinesis_firehose_connector" {
  source  = "terraform.symops.com/symopsio/kinesis-firehose-connector/sym"
  version = ">= 1.0.0"

  environment = "sandbox"
  tags        = {
    "SymEnv" = "sandbox"
  }  
}

πŸ“˜

Provisioning the Firehose

You may use the Datadog Connector for a Firehose which pipes to Datadog, or this connector + a custom Firehose for anything else.

Outputs

NameDescription
firehose_bucket_arnThe ARN of the created S3 bucket to be used by the Firehose
firehose_role_arnThe ARN of the created IAM role to be used by the Firehose

Inputs

NameDescriptionTypeDefaultRequired
environmentAn environment qualifier for the resources this module creates, to support a Terraform SDLC.stringn/ayes
name_prefixA prefix for the Firehose dependency namesstring""no
tagsAdditional tags to apply to resources.map(string){}no

Required Inputs

The following input variables are required:

Description: An environment qualifier for the resources this module creates, to support a Terraform SDLC.

Type: string

Optional Inputs

The following input variables are optional (have default values):

Description: A prefix for the Firehose dependency names

Type: string

Default: ""

Description: Additional tags to apply to resources.

Type: map(string)

Default: {}


Did this page help you?