Aiven Opensearch Terraform module

Terraform module which creates Aiven Opensearch resources

Usage

module "opensearch" {
  source       = "tf-cloud-modules/opensearch/aiven"
  project      = "test"
  service_name = "test"
}

Requirements

Name	Version
terraform	>= 0.13.1
aiven	>= 4.0.0, < 5.0.0

Providers

Name	Version
aiven	>= 4.0.0, < 5.0.0

Modules

No modules.

Resources

Name	Type
aiven_opensearch.this	resource

Inputs

Name	Description	Type	Default	Required
cloud_name	Defines where the cloud provider and region where the service is hosted in.	string	"aws-us-east-1"	no
create	Controls if resources should be created.	bool	true	no
custom_domain	Custom domain.	string	""	no
disable_replication_factor_adjustment	Disable replication factor adjustment.	bool	null	no
index_patterns	Index patterns.	any	[]	no
index_template	Index template.	any	[]	no
ip_filter_object	Allow incoming connections from CIDR address block, e.g. '10.20.0.0/16'.	list(any)	[ { "network": "0.0.0.0/0" } ]	no
keep_index_refresh_interval	Don't reset index.refresh_interval to the default value.	bool	null	no
maintenance_window_dow	Day of week when maintenance operations should be performed. One monday, tuesday, wednesday, etc.	string	"thursday"	no
maintenance_window_time	Time of day when maintenance operations should be performed. UTC time in HH:mm:ss format.	string	"01:00:00"	no
max_index_count	Maximum index count.	number	null	no
opensearch_dashboards_user_config	OpenSearch Dashboards settings.	list(any)	[]	no
opensearch_user_config	Opensearch user configurable settings.	list(any)	[]	no
opensearch_version	OpenSearch major version.	string	"1"	no
plan	Defines what kind of computing resources are allocated for the service.	string	"startup-4"	no
private_access_opensearch	Allow clients to connect to opensearch with a DNS name that always resolves to the service's private IP addresses. Only available in certain network locations.	bool	false	no
private_access_opensearch_dashboards	Allow clients to connect to opensearch_dashboards with a DNS name that always resolves to the service's private IP addresses. Only available in certain network locations.	bool	false	no
private_access_prometheus	Allow clients to connect to prometheus with a DNS name that always resolves to the service's private IP addresses.	bool	false	no
privatelink_opensearch	Enable opensearch.	bool	false	no
privatelink_opensearch_dashboards	Enable opensearch_dashboards.	bool	false	no
privatelink_prometheus	Enable prometheus.	bool	false	no
project	Aiven Cloud Project Name	string	n/a	yes
project_to_fork_from	Name of another project to fork a service from.	string	""	no
project_vpc_id	Specifies the VPC the service should run in. If the value is not set the service is not run inside a VPC.	string	null	no
public_access_opensearch	Allow clients to connect to opensearch from the public internet for service nodes that are in a project VPC or another type of private network.	bool	false	no
public_access_opensearch_dashboards	Allow clients to connect to opensearch_dashboards from the public internet for service nodes that are in a project VPC or another type of private network.	bool	false	no
public_access_prometheus	Allow clients to connect to prometheus from the public internet for service nodes that are in a project VPC or another type of private network.	bool	false	no
recovery_basebackup_name	Name of the basebackup to restore in forked service.	string	""	no
service_integrations	Service integrations to specify when creating a service.	list(any)	[]	no
service_name	Specifies the actual name of the service.	string	n/a	yes
service_to_fork_from	Name of another service to fork from.	string	""	no
static_ips	Static IPs that are going to be associated with this service.	list(string)	[]	no
tags	List of the service tags.	list(any)	[]	no
termination_protection	Prevents the service from being deleted.	bool	false	no

Outputs

Name	Description
cloud_name	Defines where the cloud provider and region where the service is hosted in.
components	Service component information objects.
disk_space_cap	The maximum disk space of the service, possible values depend on the service type, the cloud provider and the project.
disk_space_default	The default disk space of the service, possible values depend on the service type, the cloud provider and the project.
disk_space_step	The default disk space step of the service, possible values depend on the service type, the cloud provider and the project.
id	The ID of this resource.
maintenance_window_dow	Day of week when maintenance operations should be performed.
maintenance_window_time	Time of day when maintenance operations should be performed.
opensearch_user_config	Opensearch user configurable settings.
plan	Defines what kind of computing resources are allocated for the service.
project	Aiven Cloud Project Name.
service_host	The hostname of the service.
service_integrations	Service integrations to specify when creating a service.
service_name	Specifies the actual name of the service.
service_password	Password used for connecting to the service, if applicable.
service_port	The port of the service.
service_type	Aiven internal service type code.
service_uri	URI for connecting to the service.
service_username	Username used for connecting to the service.
static_ips	Static IPs that are going to be associated with this service.