Redpanda BYOVPC Module Options for AWS
This reference lists the inputs of the Redpanda BYOVPC Terraform module for AWS, version 2.3.0, grouped by purpose.
Use this reference to:
-
Look up the inputs of the Redpanda BYOVPC Terraform module for AWS
-
Find the default value of each input
-
Identify the inputs for deploying into existing VPCs and subnets
For the inputs of later releases, see the Inputs tab of the module on the Terraform Registry.
Deprecated inputs are not listed.
General
| Input | Type | Default | Description |
|---|---|---|---|
|
|
None (required) |
The AWS region for the VPC and the cluster resources. |
|
|
|
The ID of the AWS account for the cluster. If empty, the module uses the account of the identity that runs Terraform. |
|
|
|
Text added to the start of the names of resources that support name prefixes. |
|
|
|
The availability zone IDs, such as |
VPC and subnets
By default, the module creates the VPC and subnets. To deploy into a VPC that you manage, set vpc_id and the subnet ID inputs instead of the CIDR inputs. See Deploy with pre-existing VPC and subnets.
| Input | Type | Default | Description |
|---|---|---|---|
|
|
|
The CIDR block of the VPC that the module creates. Ignored when you set |
|
|
|
The CIDR blocks of the private subnets. The module creates one private subnet for each CIDR. Ignored when you set |
|
|
|
The CIDR blocks of the public subnets. The module creates one public subnet for each CIDR. Cannot be combined with |
|
|
|
The ID of an existing VPC. When set, the module does not create a VPC. Also set |
|
|
|
The IDs of existing private subnets. Provide either |
|
|
|
The IDs of existing public subnets in a VPC that you manage. Required for a dual listener cluster, which places brokers and the internet-facing seed load balancer in public subnets. Each subnet must have a route to an internet gateway and the tag |
|
|
|
Availability zone IDs that the module must not select when it adds zones to reach three. Applies only when the module creates the VPC. |
|
|
|
When |
|
|
|
Sets |
|
|
|
When |
Features
These inputs grant the extra permissions, and create the extra resources, that optional cluster features require.
| Input | Type | Default | Description |
|---|---|---|---|
|
|
|
When |
|
|
|
When |
|
|
|
When |
|
|
|
When |
|
|
|
The AWS Glue databases that hold the cluster’s Iceberg topic tables. The read-only Redpanda SQL policy allows access to these databases only. Set this to the value of the |
|
|
|
When |
|
|
|
The names of the Tiered Storage buckets of the clusters that this cluster reads from as a remote read replica. |
|
|
|
The ID of this Redpanda cluster. Required when you set |
IAM
| Input | Type | Default | Description |
|---|---|---|---|
|
|
|
Tags that restrict the IAM permissions that the module grants. The Redpanda agent can change IAM policies and roles only when they carry all of these tags. Must not be empty. Redpanda applies If several clusters share an AWS account, add a tag with the same key and a different value for each cluster, so that one cluster’s agent can’t change another cluster’s IAM resources. Use a key that doesn’t start with |
|
|
|
When |
|
|
|
When |
Storage
| Input | Type | Default | Description |
|---|---|---|---|
|
|
|
When |
|
|
|
When |
|
|
|
When |
Tags
| Input | Type | Default | Description |
|---|---|---|---|
|
|
|
Tags applied to every resource that the module creates. |