Kinesis Data Stream Addon

The kinesis-data-stream-addon module adds a policy granting AWS Kinesis Data Stream access to the Sym Runtime Connector module.

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

Kinesis Data Stream ARNs must be provided, as IAM policies for Data Streams cannot use wildcards with tags or resource names.

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

  addons      = ["aws/kinesis-data-stream"]
  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
stream_arns	List of Data Stream ARNs allowed to be accessed by the Sym Runtime.	`list(string)`	`[]`	no
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:

environment

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):

stream_arns

Description: List of Data Stream ARNs allowed to be accessed by the Sym Runtime.

Type: list(string)

Default: []

tag_name

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

Type: string

Default: "SymEnv"

Kinesis Data Stream Connector

The kinesis-data-stream-connector module provisions a single Kinesis Data Stream to which the Sym Runtime has permission to write log data.

To provide the Sym Runtime with access to the Kinesis Data Stream created in this Connector, use the aws/kinesis-data-stream addon as described above.

module "kinesis_data_stream_connector" {
  source  = "terraform.symops.com/symopsio/kinesis-data-stream-connector/sym"
  version = ">= 1.0.0"

  environment = "sandbox"
}

Outputs

Name	Description
data_stream_arn	The ARN of the created Kinesis Data Stream
data_stream_name	Name of the created data stream

Inputs

Name	Description	Type	Default	Required
encryption_type	The encryption type to use for the stream. Valid values: KMS, NONE	`string`	`"NONE"`	no
enforce_consumer_deletion	A boolean that indicates all registered consumers should be deregistered from the stream so that the stream can be destroyed without error.	`bool`	`false`	no
environment	An environment qualifier for the resources this module creates, to support a Terraform SDLC.	`string`	n/a	yes
kms_key_id	The ID of the KMS key to use for encryption. Required if encryption_type is set to KMS.	`string`	`""`	no
name_prefix	A prefix for the Data Stream and Consumer names	`string`	`""`	no
retention_period	Length of time data records are accessible after they are added to the stream (in hours). Range: 24 - 8760	`number`	`24`	no
shard_count	The number of shards that the stream will use.	`number`	`1`	no
shard_level_metrics	A list of shard-level CloudWatch metrics which can be enabled for the stream.	`list(string)`	`[]`	no
tags	Additional tags to apply to resources.	`map(string)`	`{}`	no

Required Inputs

The following input variables are required:

environment

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):

encryption_type

Description: The encryption type to use for the stream. Valid values: KMS, NONE

Type: string

Default: "NONE"

enforce_consumer_deletion

Description: A boolean that indicates all registered consumers should be deregistered from the stream so that the stream can be destroyed without error.

Type: bool

Default: false