models

Documentation

Overview

Package models contains all the Terraform schema representations of the resources created by the Redpanda Terraform provider.

Index

• type ACL
• type AwsPrivateLink
• type AzurePrivateLink
• type Cluster
• type GcpPrivateServiceConnect
• type GcpPrivateServiceConnectConsumer
• type HTTPProxy
• type KafkaAPI
• type Mtls
• type Network
• type Redpanda
• type Region
• type Regions
• type RegionsItem
• type ResourceGroup
• type SchemaRegistry
• type ServerlessCluster
• type ServerlessRegions
• type ServerlessRegionsItem
• type ThroughputTiers
• type ThroughputTiersItem
• type Topic
• type User

Types

type ACL

type ACL struct {
	ResourceType        types.String `tfsdk:"resource_type"`
	ResourceName        types.String `tfsdk:"resource_name"`
	ResourcePatternType types.String `tfsdk:"resource_pattern_type"`
	Principal           types.String `tfsdk:"principal"`
	Host                types.String `tfsdk:"host"`
	Operation           types.String `tfsdk:"operation"`
	PermissionType      types.String `tfsdk:"permission_type"`
	ClusterAPIURL       types.String `tfsdk:"cluster_api_url"`
	ID                  types.String `tfsdk:"id"`
}

ACL defines the structure for configuration settings parsed from HCL.

type AwsPrivateLink

type AwsPrivateLink struct {
	Enabled           types.Bool `tfsdk:"enabled"`
	ConnectConsole    types.Bool `tfsdk:"connect_console"`
	AllowedPrincipals types.List `tfsdk:"allowed_principals"`
}

AwsPrivateLink represents the Terraform schema for the AWS Private Link configuration.

type AzurePrivateLink

type AzurePrivateLink struct {
	AllowedSubscriptions types.List `tfsdk:"allowed_subscriptions"`
	ConnectConsole       types.Bool `tfsdk:"connect_console"`
	Enabled              types.Bool `tfsdk:"enabled"`
}

AzurePrivateLink represents the Terraform schema for the Azure Private Link configuration.

type Cluster

type Cluster struct {
	Name                     types.String              `tfsdk:"name"`
	ID                       types.String              `tfsdk:"id"`
	ConnectionType           types.String              `tfsdk:"connection_type"`
	CloudProvider            types.String              `tfsdk:"cloud_provider"`
	ClusterType              types.String              `tfsdk:"cluster_type"`
	RedpandaVersion          types.String              `tfsdk:"redpanda_version"`
	ThroughputTier           types.String              `tfsdk:"throughput_tier"`
	Region                   types.String              `tfsdk:"region"`
	Zones                    types.List                `tfsdk:"zones"`
	AllowDeletion            types.Bool                `tfsdk:"allow_deletion"`
	Tags                     types.Map                 `tfsdk:"tags"`
	ResourceGroupID          types.String              `tfsdk:"resource_group_id"`
	NetworkID                types.String              `tfsdk:"network_id"`
	ClusterAPIURL            types.String              `tfsdk:"cluster_api_url"`
	AwsPrivateLink           *AwsPrivateLink           `tfsdk:"aws_private_link"`
	GcpPrivateServiceConnect *GcpPrivateServiceConnect `tfsdk:"gcp_private_service_connect"`
	AzurePrivateLink         *AzurePrivateLink         `tfsdk:"azure_private_link"`
	KafkaAPI                 *KafkaAPI                 `tfsdk:"kafka_api"`
	HTTPProxy                *HTTPProxy                `tfsdk:"http_proxy"`
	SchemaRegistry           *SchemaRegistry           `tfsdk:"schema_registry"`
	ReadReplicaClusterIDs    types.List                `tfsdk:"read_replica_cluster_ids"`
}

Cluster represents the Terraform schema for the cluster resource.

type GcpPrivateServiceConnect

type GcpPrivateServiceConnect struct {
	Enabled             types.Bool                          `tfsdk:"enabled"`
	GlobalAccessEnabled types.Bool                          `tfsdk:"global_access_enabled"`
	ConsumerAcceptList  []*GcpPrivateServiceConnectConsumer `tfsdk:"consumer_accept_list"`
}

GcpPrivateServiceConnect represents the Terraform schema for the GCP Private Service Connect configuration.

type GcpPrivateServiceConnectConsumer

type GcpPrivateServiceConnectConsumer struct {
	Source string `tfsdk:"source"`
}

GcpPrivateServiceConnectConsumer represents the Terraform schema for the GCP Private Service Connect consumer configuration.

type HTTPProxy

type HTTPProxy struct {
	Mtls *Mtls `tfsdk:"mtls"`
}

HTTPProxy represents the Terraform schema for the HTTP Proxy configuration.

type KafkaAPI

type KafkaAPI struct {
	Mtls *Mtls `tfsdk:"mtls"`
}

KafkaAPI represents the Terraform schema for the Kafka API configuration.

type Mtls

type Mtls struct {
	Enabled               types.Bool `tfsdk:"enabled"`
	CaCertificatesPem     types.List `tfsdk:"ca_certificates_pem"`
	PrincipalMappingRules types.List `tfsdk:"principal_mapping_rules"`
}

Mtls represents the Terraform schema for the mutual TLS configuration.

type Network

type Network struct {
	Name            types.String `tfsdk:"name"`
	ResourceGroupID types.String `tfsdk:"resource_group_id"`
	CloudProvider   types.String `tfsdk:"cloud_provider"`
	Region          types.String `tfsdk:"region"`
	CidrBlock       types.String `tfsdk:"cidr_block"`
	ID              types.String `tfsdk:"id"`
	ClusterType     types.String `tfsdk:"cluster_type"`
}

Network represents the Terraform schema for the network resource.

type Redpanda

type Redpanda struct {
	AccessToken         types.String `tfsdk:"access_token"`
	ClientID            types.String `tfsdk:"client_id"`
	ClientSecret        types.String `tfsdk:"client_secret"`
	AzureSubscriptionID types.String `tfsdk:"azure_subscription_id"`
	GcpProjectID        types.String `tfsdk:"gcp_project_id"`
}

Redpanda represents the Terraform schema for the Redpanda TF provider.

type Region

type Region struct {
	CloudProvider types.String `tfsdk:"cloud_provider"`
	Name          types.String `tfsdk:"name"`
	Zones         []string     `tfsdk:"zones"`
}

Region represents the Terraform model for the Region data source.

type Regions

type Regions struct {
	CloudProvider types.String  `tfsdk:"cloud_provider"`
	Regions       []RegionsItem `tfsdk:"regions"`
}

Regions represents the Terraform model for the Regions data source.

type RegionsItem

type RegionsItem struct {
	Name  string   `tfsdk:"name"`
	Zones []string `tfsdk:"zones"`
}

RegionsItem represents a single region in a Regions data source.

type ResourceGroup

type ResourceGroup struct {
	Name types.String `tfsdk:"name"`
	ID   types.String `tfsdk:"id"`
}

ResourceGroup represents the Terraform schema for the ResourceGroup resource.

type SchemaRegistry

type SchemaRegistry struct {
	Mtls *Mtls `tfsdk:"mtls"`
}

SchemaRegistry represents the Terraform schema for the Schema Registry configuration.

type ServerlessCluster

type ServerlessCluster struct {
	Name             types.String `tfsdk:"name"`
	ID               types.String `tfsdk:"id"`
	ServerlessRegion types.String `tfsdk:"serverless_region"`
	ResourceGroupID  types.String `tfsdk:"resource_group_id"`
	ClusterAPIURL    types.String `tfsdk:"cluster_api_url"`
}

ServerlessCluster represents the Terraform schema for the serverless cluster resource.

type ServerlessRegions

type ServerlessRegions struct {
	CloudProvider     types.String            `tfsdk:"cloud_provider"`
	ServerlessRegions []ServerlessRegionsItem `tfsdk:"serverless_regions"`
}

ServerlessRegions represents the Terraform model for the ServerlessRegions data source.

type ServerlessRegionsItem

type ServerlessRegionsItem struct {
	Available   bool   `tfsdk:"available"`
	DisplayName string `tfsdk:"display_name"`
	Name        string `tfsdk:"name"`
}

ServerlessRegionsItem represents a single region in a ServerlessRegions data source.

type ThroughputTiers

type ThroughputTiers struct {
	CloudProvider   types.String          `tfsdk:"cloud_provider"`
	ThroughputTiers []ThroughputTiersItem `tfsdk:"throughput_tiers"`
}

ThroughputTiers represents the Terraform model for the Throughput Tiers data source.

type ThroughputTiersItem

type ThroughputTiersItem struct {
	CloudProvider string `tfsdk:"cloud_provider"`
	DisplayName   string `tfsdk:"display_name"`
	Name          string `tfsdk:"name"`
}

ThroughputTiersItem represents a single tier in a Throughput Tiers data source.

type Topic

type Topic struct {
	Name              types.String `tfsdk:"name"`
	PartitionCount    types.Number `tfsdk:"partition_count"`
	ReplicationFactor types.Number `tfsdk:"replication_factor"`
	Configuration     types.Map    `tfsdk:"configuration"`
	AllowDeletion     types.Bool   `tfsdk:"allow_deletion"`
	ClusterAPIURL     types.String `tfsdk:"cluster_api_url"`
	ID                types.String `tfsdk:"id"`
}

Topic defines the structure for configuration settings parsed from HCL.

type User

type User struct {
	Name          types.String `tfsdk:"name"`
	Password      types.String `tfsdk:"password"`
	Mechanism     types.String `tfsdk:"mechanism"`
	ID            types.String `tfsdk:"id"`
	ClusterAPIURL types.String `tfsdk:"cluster_api_url"`
}

User defines the structure for configuration settings parsed from HCL.