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
| Name | Description |
|---|---|
| policy_arn | Kinesis Firehose's access policy arn |
Inputs
| Name | Description | Type | Default | Required |
|---|---|---|---|---|
| environment | 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. | string | n/a | yes |
| tag_name | Name of the tag that resources must be tagged with to be accessible by this addon. | string | "SymEnv" | no |
| tags | Additional 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. 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
| Name | Description |
|---|---|
| firehose_bucket_arn | The ARN of the created S3 bucket to be used by the Firehose |
| firehose_role_arn | The ARN of the created IAM role to be used by the Firehose |
Inputs
| Name | Description | Type | Default | Required |
|---|---|---|---|---|
| environment | An environment qualifier for the resources this module creates, to support a Terraform SDLC. | string | n/a | yes |
| name_prefix | A prefix for the Firehose dependency names | string | "" | no |
| tags | Additional 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: {}
Updated 5 months ago