DBParameterGroup | Praxis resources

Resource definition

What this resource looks like

This is the CUE shape a Praxis template uses to declare a DBParameterGroup. The resource key is local to the template; metadata.name supplies its stable Praxis identity.

resources: {
  dbParamGroup: {
  	apiVersion: "praxis.io/alpha"
  	kind:       "DBParameterGroup"
  	metadata: name: "\(_naming.prefix)-db-params"
  	spec: {
  		region:      _naming.region
  		family:      variables.dbFamily
  		description: "Custom PostgreSQL parameters for \(_naming.prefix)"
  		parameters: {
  			"shared_buffers":  "256MB"
  			"max_connections":  "200"
  			"log_statement":    "all"
  			"log_min_duration_statement": "500"
  		}
  		tags: #DataTags
  	}
  }
}

Excerpted from examples/stacks/end-to-end.cue. Open the complete example for its variables and related resources.

Complete examples in the repository

stacks end to end stacks saas platform

Desired state

Configuration

The spec block accepts 6 fields. 4 are required by the schema; fields with defaults can be omitted.

regionRequired

Region.

string

String

typeOptional

Type.

"db" | "cluster" | *"db"

EnumDefault "db"

familyRequired

Family.

string

String

descriptionOptional

Description.

string | *""

EnumDefault ""

parametersRequired

Parameters.

[string]: string

Map

tagsRequired

Tags.

[string]: string

Map

Observed values

Outputs

Praxis records these values after observation. A dependent resource can read one with ${resources.<name>.outputs.<field>}.

groupNameString

arnString

familyString

typeString

Read without ownership

Data-source lookup

A data block reads an existing DBParameterGroup and exposes its outputs without storing lifecycle state. The generic filter surface accepts id, name, and tag; supported combinations depend on the AWS identity used by this resource.

data: existing: {
  kind: "DBParameterGroup"
  region: "us-west-2"
  filter: {
    name: "replace-with-provider-name"
  }
}

Understand data sources and filters →

Adopt existing infrastructure

Import

Import persists Praxis state for an existing AWS resource. For this kind, supply: Provider identifier for the existing DBParameterGroup. The example starts in observed mode so Praxis reports drift without correcting it.

praxis import DBParameterGroup \
  --id <provider-identifier> \
  --region us-west-2 \
  --account production \
  --observe

Choose managed or observed ownership →

Canonical contract

Complete CUE schema

The field guide above is derived from this definition. The schema remains the source of truth for accepted values, defaults, validation constraints, and outputs in the current alpha revision.

Show the complete schema

package rds

#DBParameterGroup: {
	apiVersion: "praxis.io/alpha"
	kind:       "DBParameterGroup"

	metadata: {
		name: string & =~"^[a-zA-Z][a-zA-Z0-9-]{0,253}[a-zA-Z0-9]$"
		labels: [string]: string
	}

	spec: {
		region:      string
		type:        "db" | "cluster" | *"db"
		family:      string
		description: string | *""
		parameters: [string]: string
		tags: [string]:       string
	}

	outputs?: {
		groupName: string
		arn:       string
		family:    string
		type:      string
	}
}

View this schema on GitHub →