opensearch

idealo/opensearch/aws

Terraform Module HCL AWS

Terraform module to provision an OpenSearch cluster with SAML authentication.

Install
module "opensearch" {
source = "idealo/opensearch/aws"
version = "2.2.0"
}
plain text: /constructs/tfmod-idealo-opensearch-aws/install.txt
⭐ Source on GitHub 📦 Registry page
README

AWS OpenSearch Terraform Module Terraform module to provision an OpenSearch cluster with SAML authentication. Prerequisites - A hosted zone to route traffic to your OpenSearch domain - An entityID and metadata XML from your SAML identity provider (in case saml_enabled = true) Features - Create an AWS OpenSearch cluster with SAML authentication - All node types with local NVMe for high IO performance are supported - Create or manage various OpenSearch resources: - Index templates - Indices - ISM policies - Roles - Role mappings Usage This example is using Azure AD as SAML identity provider. ``terraform locals { cluster_name = "opensearch" cluster_domain = "example.com" saml_entity_id = "https://sts.windows.net/XXX-XXX-XXX-XXX-XXX/" saml_metadata_url = "https://login.microsoftonline.com/XXX-

Inputs (50)
NameTypeDescriptionDefault
cluster_domainstringThe hosted zone name of the OpenSearch cluster. required
vpc_enabledboolIndicates whether the cluster is running inside a VPC.false
access_policiesstringIAM policy document specifying the access policies for the domain.null
cluster_versionstringThe version of OpenSearch to deploy."2.11"
warm_instance_countnumberThe number of dedicated warm nodes in the cluster.3
ebs_volume_sizenumberThe size of EBS volumes attached to data nodes (in GiB).10
ebs_throughputnumberThe throughput (in MiB/s) of the EBS volumes attached to data nodes. Valid value125
saml_roles_keystringElement of the SAML assertion to use for backend roles."http://schemas.microsoft.com/ws/2008/06
index_filesset(string)A set of all index files to create.[]
advanced_optionsmap(string)Key-value string pairs to specify advanced configuration options.null
auto_tune_optionsobject({ maintenance_schedConfiguration block for auto-tune options. The maintenance schedule block is req{ "maintenance_schedule": [], "rollb
create_service_roleboolIndicates whether to create the service-linked role. See https://docs.aws.amazontrue
encrypt_kms_key_idstringThe KMS key ID to encrypt the OpenSearch cluster with. If not specified, then it""
saml_session_timeoutnumberDuration of a session in minutes after a user logs in. Default is 60. Maximum va60
master_instance_typestringThe type of EC2 instances to run for each master node. A list of available insta"r6gd.large.elasticsearch"
availability_zonesnumberThe number of availability zones for the OpenSearch cluster. Valid values: 1, 2 3
rolesmap(any)A map of all roles to create.{}
advanced_security_options_internal_user_database_enabledboolWhether to enable or not internal Kibana user database for ELK OpenDistro securifalse
encrypt_at_rest_enabledboolConfiguration block for encrypt at rest optionstrue
ebs_enabledboolIndicates whether attach EBS volumes to the data nodes.false
ebs_volume_typestringThe type of EBS volumes attached to data nodes."gp3"
… and 10 more inputs
Outputs (4)
cluster_endpoint — The endpoint URL of the OpenSearch cluster.
kibana_endpoint — The endpoint URL of the OpenSearch dashboards.
cluster_name — The name of the OpenSearch cluster.
cluster_version — The version of the OpenSearch cluster.
Resources (12)
aws_cloudwatch_log_groupaws_cloudwatch_log_resource_policyaws_elasticsearch_domainaws_elasticsearch_domain_saml_optionsaws_iam_service_linked_roleaws_route53_recordopensearch_composable_index_templateopensearch_indexopensearch_index_templateopensearch_ism_policyopensearch_roleopensearch_roles_mapping
Details
FrameworkTerraform Module
LanguageHCL
Version2.2.0
Cloud AWS
★ Stars69
Forks54
Total downloads112.9k
Inputs50
Outputs4
Resources12
Examples2
LicenseApache-2.0
Namespaceidealo
Updated