Skip to content

aws.rds-cluster-instance resource

Description

ClusterInstance is one member of an Aurora or Multi-AZ DB cluster. The cluster owns the storage, master credentials, encryption, and backup retention, so a member declares only its compute class, placement, monitoring, and Performance Insights settings, plus the cluster it joins. The cluster identifier, identifier, engine, Availability Zone, subnet group, and custom instance profile are fixed at create time, so a change to any of them replaces the member; every other field is reconciled in place by a single ModifyDBInstance.

The CA certificate identifier is not a CreateDBInstance setting: on create it is reconciled, only when it differs from the value the create returned, by a ModifyDBInstance followed by a reboot, since the certificate takes effect only after a reboot. Force-destroy is a delete-time behavior, not a setting sent to any API: it permits freeing the last member of a read-replica cluster by promoting the cluster.

A member of a cluster never owns a snapshot, so there are no final-snapshot, storage, credential, or KMS inputs here; the cluster owns all of those.

Source: internal/service/rds/cluster_instance_rsrc.go:150

Example usage:

imports: {
  aws: 'github.com/cloudboss/unobin-library-aws'
}

resources: {
  example: aws.rds-cluster-instance {
    # Set input fields here.
  }
}

Inputs

cluster-identifier

string

required

instance-class

string

required

engine

string

required

identifier

string

required

availability-zone

optional(string)

db-parameter-group-name

optional(string)

db-subnet-group-name

optional(string)

custom-iam-instance-profile

optional(string)

engine-version

optional(string)

auto-minor-version-upgrade

optional(boolean)

copy-tags-to-snapshot

optional(boolean)

promotion-tier

optional(integer)

publicly-accessible

optional(boolean)

monitoring-interval

optional(integer)

monitoring-role-arn

optional(string)

performance-insights-enabled

optional(boolean)

performance-insights-kms-key-id

optional(string)

performance-insights-retention-period

optional(integer)

preferred-backup-window

optional(string)

preferred-maintenance-window

optional(string)

ca-cert-identifier

optional(string)

force-destroy

optional(boolean)

tags

map(string)

Input Constraints

Performance insights retention period rules

performance-insights-retention-period must be between 7 and 731.

Rule logic
When
input.performance-insights-retention-period != null
Require
(input.performance-insights-retention-period == null || input.performance-insights-retention-period >= 7)
&& (input.performance-insights-retention-period == null || input.performance-insights-retention-period <= 731)

Outputs

arn

string

endpoint

string

port

integer

writer

boolean

dbi-resource-id

string

kms-key-id

string

storage-encrypted

boolean

network-type

string

engine-version-actual

string

availability-zone

string

ca-cert-identifier

string

db-parameter-group-name

string

preferred-backup-window

string

preferred-maintenance-window

string