Skip to content

rds_cluster.md

Latest commit

 

History

History
118 lines (95 loc) · 6.01 KB

rds_cluster.md

File metadata and controls

118 lines (95 loc) · 6.01 KB
Raw
page_title duploai_rds_cluster Data Source - duploai
subcategory
description Manages a DuploCloud AI Helpdesk AWS RDS (Aurora) cluster.

duploai_rds_cluster (Data Source)

Manages a DuploCloud AI Helpdesk AWS RDS (Aurora) cluster.

Example Usage

# Look up an RDS cluster by ID.
data "duploai_rds_cluster" "example" {
  workspace_id = "<workspace-id>"
  id           = "<object-id>"
}

output "status" {
  value = data.duploai_rds_cluster.example.status
}

output "cluster_endpoint" {
  value = data.duploai_rds_cluster.example.cluster_endpoint
}

output "port" {
  value = data.duploai_rds_cluster.example.port
}

Schema

Required

  • id (String) ID of the object to look up.
  • workspace_id (String) ID of the workspace that owns this RDS cluster.

Read-Only

  • auto_minor_version_upgrade (Boolean) Automatically apply minor engine version upgrades.
  • backtrack_window (Number) Target backtrack window in seconds (Aurora MySQL only). 0 disables backtracking.
  • backup_retention_period (Number) Number of days automated backups are retained.
  • ca_certificate_identifier (String) CA certificate identifier for the cluster.
  • cluster_endpoint (String) Writer (primary) endpoint of the provisioned cluster.
  • cluster_instances (Attributes List) Instances (writer/readers) that make up the cluster. (see below for nested schema)
  • cluster_parameters (Attributes List) Cluster parameter group overrides. (see below for nested schema)
  • copy_tags_to_snapshot (Boolean) Copy cluster tags to snapshots.
  • database_insights_mode (String) Database Insights mode (e.g. standard, advanced).
  • db_name (String) Name of the initial database created in the cluster.
  • db_subnet_group_name (String) DB subnet group the cluster is placed in.
  • deletion_protection (Boolean) Enable deletion protection on the cluster.
  • description (String) Optional description.
  • enable_cloudwatch_logs_exports (List of String) Log types to export to CloudWatch (e.g. postgresql, audit, error).
  • enable_http_endpoint (Boolean) Enable the Data API (HTTP endpoint) for the cluster.
  • enable_iam_database_authentication (Boolean) Enable IAM database authentication.
  • enable_performance_insights (Boolean) Enable Performance Insights.
  • engine (String) Database engine (e.g. aurora-postgresql, aurora-mysql).
  • engine_mode (String) Cluster engine mode. Accepted values are defined by the backend RdsClusterEngineMode enum (e.g. the provisioned vs. serverless mode); confirm the exact value against your tenant.
  • engine_version (String) Engine version. Changing this in place triggers an engine upgrade.
  • environment_id (String) ID of the environment that owns the resource group.
  • kms_key_id (String) KMS key ID used for storage encryption.
  • manage_master_user_password (Boolean) Let AWS manage the master user password in Secrets Manager instead of supplying master_user_password.
  • master_user_password (String, Sensitive) Master user password. Omit when manage_master_user_password is true.
  • master_user_secret_arn (String) Secrets Manager ARN holding the master credentials (when manage_master_user_password is enabled).
  • master_username (String) Master (admin) username. Required when creating a new cluster (not restoring from a snapshot).
  • name (String) Name of the RDS cluster.
  • port (Number) Port the cluster listens on.
  • preferred_backup_window (String) Daily time range (UTC) for automated backups, e.g. 07:00-09:00.
  • preferred_maintenance_window (String) Weekly time range (UTC) for maintenance, e.g. sun:05:00-sun:06:00.
  • provisioner_type (String) Provisioner type: Cli, IacNativeTf, IacDuploTf, or DirectApiCall.
  • provisioner_version (String) Optional provisioner version.
  • rds_cluster_id (String) ID of this RDS cluster, for reference by dependent resources.
  • reader_endpoint (String) Reader endpoint of the provisioned cluster.
  • resource_group_id (String) ID of the resource group (under an environment) this cluster belongs to.
  • scope_ids (List of String) Scope IDs that link this cluster to a cloud provider account.
  • serverless_v2_scaling (Attributes) Aurora Serverless v2 capacity range, in ACUs. (see below for nested schema)
  • snapshot_identifier (String) Identifier of a snapshot to restore the cluster from.
  • stack_id (String) ID of the underlying provisioning stack.
  • status (String) Current provisioning status.
  • storage_encrypted (String) Storage encryption mode. Accepted values are defined by the backend RdsStorageEncryptionMode enum; confirm the exact value against your tenant.
  • storage_type (String) Cluster storage type (e.g. aurora, aurora-iopt1).
  • visibility (String) Network visibility of the cluster. Accepted values are defined by the backend RdsVisibility enum (e.g. private vs. public); confirm the exact value against your tenant.
  • vpc_security_group_ids (List of String) VPC security group IDs attached to the cluster.

Nested Schema for cluster_instances

Read-Only:

  • availability_zone (String) Availability zone for the instance.
  • ca_certificate_identifier (String) CA certificate identifier for the instance.
  • db_instance_class (String) Instance class (e.g. db.r6g.large, db.serverless).
  • name (String) Instance identifier.
  • performance_insights_retention_period (Number) Performance Insights retention period in days.
  • promotion_tier (Number) Failover promotion tier (0-15; lower is promoted first).

Nested Schema for cluster_parameters

Read-Only:

  • name (String) Parameter name.
  • value (String) Parameter value.

Nested Schema for serverless_v2_scaling

Read-Only:

  • max_capacity (Number) Maximum Aurora capacity units.
  • min_capacity (Number) Minimum Aurora capacity units.