Skip to content

[Automated Preview][terraform-aws-service-catalog] feat(data-stores): add opensearch module, deprecate elasticsearch #3186

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
docs-sourcer wants to merge 1 commit into
base: main
Choose a base branch
from
Open

[Automated Preview][terraform-aws-service-catalog] feat(data-stores): add opensearch module, deprecate elasticsearch #3186

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
59 changes: 58 additions & 1 deletion docs/reference/services/data-storage/amazon-aurora.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -162,6 +162,12 @@ module "aurora" {
# the engine is allowed. Default value is true.
auto_minor_version_upgrade = true

# The amount of time in minutes before a backup job is canceled if it does not
# complete successfully. Maps to the backup plan rule's completion_window.
# Must be at least 60 minutes greater than var.backup_start_window. If null,
# AWS Backup uses its default.
backup_completion_window = null

# The number of days to retain recovery points in the destination backup vault
# before automatic deletion. Only used if var.backup_destination_vault_arn is
# set.
Expand All @@ -171,6 +177,10 @@ module "aurora" {
# copies. If null, no cross-account copy is configured.
backup_destination_vault_arn = null

# A map of tags to assign to the recovery points (backups) created by the
# backup plan rule. If null, no recovery point tags are applied.
backup_recovery_point_tags = null

# How many days to keep backup snapshots around before cleaning them up. Max:
# 35
backup_retention_period = 30
Expand All @@ -188,6 +198,11 @@ module "aurora" {
# before automatic deletion.
backup_source_retention_days = 30

# The amount of time in minutes before a backup job is canceled if it does not
# start successfully. Maps to the backup plan rule's start_window. If null,
# AWS Backup uses its default.
backup_start_window = null

# The ARN of a KMS key used to encrypt the backup vault. If null, the default
# AWS Backup encryption will be used.
backup_vault_kms_key_arn = null
Expand Down Expand Up @@ -677,6 +692,12 @@ inputs = {
# the engine is allowed. Default value is true.
auto_minor_version_upgrade = true

# The amount of time in minutes before a backup job is canceled if it does not
# complete successfully. Maps to the backup plan rule's completion_window.
# Must be at least 60 minutes greater than var.backup_start_window. If null,
# AWS Backup uses its default.
backup_completion_window = null

# The number of days to retain recovery points in the destination backup vault
# before automatic deletion. Only used if var.backup_destination_vault_arn is
# set.
Expand All @@ -686,6 +707,10 @@ inputs = {
# copies. If null, no cross-account copy is configured.
backup_destination_vault_arn = null

# A map of tags to assign to the recovery points (backups) created by the
# backup plan rule. If null, no recovery point tags are applied.
backup_recovery_point_tags = null

# How many days to keep backup snapshots around before cleaning them up. Max:
# 35
backup_retention_period = 30
Expand All @@ -703,6 +728,11 @@ inputs = {
# before automatic deletion.
backup_source_retention_days = 30

# The amount of time in minutes before a backup job is canceled if it does not
# start successfully. Maps to the backup plan rule's start_window. If null,
# AWS Backup uses its default.
backup_start_window = null

# The ARN of a KMS key used to encrypt the backup vault. If null, the default
# AWS Backup encryption will be used.
backup_vault_kms_key_arn = null
Expand Down Expand Up @@ -1216,6 +1246,15 @@ Configure the auto minor version upgrade behavior. This is applied to the cluste
<HclListItemDefaultValue defaultValue="true"/>
</HclListItem>

<HclListItem name="backup_completion_window" requirement="optional" type="number">
<HclListItemDescription>

The amount of time in minutes before a backup job is canceled if it does not complete successfully. Maps to the backup plan rule's completion_window. Must be at least 60 minutes greater than <a href="#backup_start_window"><code>backup_start_window</code></a>. If null, AWS Backup uses its default.

</HclListItemDescription>
<HclListItemDefaultValue defaultValue="null"/>
</HclListItem>

<HclListItem name="backup_destination_retention_days" requirement="optional" type="number">
<HclListItemDescription>

Expand All @@ -1234,6 +1273,15 @@ The ARN of a destination backup vault for cross-account or cross-region copies.
<HclListItemDefaultValue defaultValue="null"/>
</HclListItem>

<HclListItem name="backup_recovery_point_tags" requirement="optional" type="map(string)">
<HclListItemDescription>

A map of tags to assign to the recovery points (backups) created by the backup plan rule. If null, no recovery point tags are applied.

</HclListItemDescription>
<HclListItemDefaultValue defaultValue="null"/>
</HclListItem>

<HclListItem name="backup_retention_period" requirement="optional" type="number">
<HclListItemDescription>

Expand Down Expand Up @@ -1270,6 +1318,15 @@ The number of days to retain recovery points in the source backup vault before a
<HclListItemDefaultValue defaultValue="30"/>
</HclListItem>

<HclListItem name="backup_start_window" requirement="optional" type="number">
<HclListItemDescription>

The amount of time in minutes before a backup job is canceled if it does not start successfully. Maps to the backup plan rule's start_window. If null, AWS Backup uses its default.

</HclListItemDescription>
<HclListItemDefaultValue defaultValue="null"/>
</HclListItem>

<HclListItem name="backup_vault_kms_key_arn" requirement="optional" type="string">
<HclListItemDescription>

Expand Down Expand Up @@ -2600,6 +2657,6 @@ ID of security group created by aurora module.
"https://github.com/gruntwork-io/terraform-aws-service-catalog/tree/v2.11.0/modules/data-stores/aurora/outputs.tf"
],
"sourcePlugin": "service-catalog-api",
"hash": "9805e5c705ea16bd09f81ee3033f556c"
"hash": "c478a742a0092aa4a0285bcdddb4de8e"
}
##DOCS-SOURCER-END -->
21 changes: 20 additions & 1 deletion docs/reference/services/data-storage/amazon-elasticsearch.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,25 @@ import { HclListItem, HclListItemDescription, HclListItemTypeDetails, HclListIte

# Amazon Elasticsearch Service

> \[!WARNING]
> **Deprecated.** AWS has renamed Amazon Elasticsearch Service to Amazon OpenSearch Service, and this module
> (which manages the legacy `aws_elasticsearch_domain` resource) is deprecated in favor of the
> [`opensearch`](/reference/services/data-storage/amazon-open-search) module, which manages `aws_opensearch_domain`. New deployments should use
> `opensearch`. This module remains for existing consumers and will be removed in a future major release.
>
> **Migrating an existing domain:** `aws_elasticsearch_domain` and `aws_opensearch_domain` manage the same
> underlying AWS OpenSearch Service domain, so migration relocates Terraform state without touching AWS. After
> switching your module `source` to `opensearch` and mapping inputs to the new variable names (e.g.
> `elasticsearch_version` -&gt; `engine_version`, `is_public`/`iam_principal_arns` -&gt; `access_policies`), move the
> domain in state:
>
> ```bash
> terraform state rm 'module.<name>.aws_elasticsearch_domain.cluster'
> terraform import 'module.<name>.module.domain.aws_opensearch_domain.domain' <domain_name>
> ```
>
> Run `terraform plan` afterward and confirm it shows no destroy/recreate of the domain.

<a href="https://github.com/gruntwork-io/terraform-aws-service-catalog/tree/v2.11.0/modules/data-stores/elasticsearch" className="link-button" title="View the source code for this service in GitHub.">View Source</a>

<a href="https://github.com/gruntwork-io/terraform-aws-service-catalog/releases?q=data-stores%2Felasticsearch" className="link-button" title="Release notes for only versions which impacted this service.">Release Notes</a>
Expand Down Expand Up @@ -1598,6 +1617,6 @@ Domain-specific endpoint for Kibana without https scheme.
"https://github.com/gruntwork-io/terraform-aws-service-catalog/tree/v2.11.0/modules/data-stores/elasticsearch/outputs.tf"
],
"sourcePlugin": "service-catalog-api",
"hash": "9eeffde7b37d0c0ba68c841389278cd0"
"hash": "f755e074bab200c79241d7ddce5f4056"
}
##DOCS-SOURCER-END -->
Loading